de.matthias_burbach.mosaique.core.model
Class AbstractFileItem

java.lang.Object
  de.matthias_burbach.mosaique.core.model.AbstractFileItem

Direct Known Subclasses:

Definition, Insert, Jsp, LogicalPage, Put, StrutsConfig

public abstract class AbstractFileItem

extends java.lang.Object

Is the abstract base class for parsed objects that relate to a file and a specific part of a file.

Author:

Matthias Burbach

Constructor Summary

AbstractFileItem()

Method Summary

int	getBegin()
protected Context	getContext()
protected DefinitionResolver	getDefinitionResolver()
int	getEnd()
java.lang.String	getFilePath()
protected JspResolver	getJspResolver()
java.lang.String	getMessage()
java.lang.String	getPrimarySearchText()
java.lang.String	getSecondarySearchText()
boolean	isErroneous()
void	setBegin(int begin)
protected void	setContext(Context context)
void	setEnd(int end)
void	setErroneous(boolean erroneous)
void	setFilePath(java.lang.String filePath)
void	setMessage(java.lang.String message)
void	setPrimarySearchText(java.lang.String primarySearchText)
void	setSecondarySearchText(java.lang.String secondarySearchText)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractFileItem

public AbstractFileItem()

Method Detail

getMessage

public java.lang.String getMessage()

Returns:

A message about this file item. Can be an error message if isErroneous() is true.

setMessage

public void setMessage(java.lang.String message)

Parameters:

message - A message about this file item. Can be an error message if isErroneous() is true.

isErroneous

public boolean isErroneous()

Returns:

Signals that the (creator of the) node has discovered an error related to this node. Can be used to display the error state, for example.

setErroneous

public void setErroneous(boolean erroneous)

Parameters:

erroneous - Signals that the (creator of the) node has discovered an error related to this node. Can be used to display the error state, for example.

getFilePath

public java.lang.String getFilePath()

Returns:

The full path of the file this item relates to.

setFilePath

public void setFilePath(java.lang.String filePath)

Parameters:

filePath - The full path of the file this item relates to.

getBegin

public int getBegin()

Returns:

The character begin position of the text this item was parsed from. -1 means unknown.

setBegin

public void setBegin(int begin)

Parameters:

begin - The character begin position of the text this item was parsed from. -1 means unknown.

getEnd

public int getEnd()

Returns:

The column number where the text this item was parsed from starts. -1 means unknown.

setEnd

public void setEnd(int end)

Parameters:

end - The character end position of the text this item was parsed from. -1 means unknown.

getPrimarySearchText

public java.lang.String getPrimarySearchText()

Returns:

The text to search for within the underlying text file to find the text this item was parsed from. Can be null.

setPrimarySearchText

public void setPrimarySearchText(java.lang.String primarySearchText)

Parameters:

primarySearchText - The text to search for within the underlying text file to find the text this item was parsed from. Can be null.

getSecondarySearchText

public java.lang.String getSecondarySearchText()

Returns:

The text to search for within the underlying text file relative to the matching position of the primary search text to find the text this item was parsed from. Can be null.

setSecondarySearchText

public void setSecondarySearchText(java.lang.String secondarySearchText)

Parameters:

secondarySearchText - The text to search for within the underlying text file relative to the matching position of the primary search text to find the text this item was parsed from. Can be null.

getContext

protected Context getContext()

Returns:

The context holding the objects to be shared by a cluster of application objects.

setContext

protected void setContext(Context context)

Parameters:

context - The context holding the objects to be shared by a cluster of application objects.

getDefinitionResolver

protected DefinitionResolver getDefinitionResolver()

Returns:

The definition resolver to use by this instance (in subclass code).

getJspResolver

protected JspResolver getJspResolver()

Returns:

The JSP resolver to use by this instance (in subclass code).