org.pfsw.textx

Class TextEngine

java.lang.Object

org.pfsw.textx.TextEngine

public class TextEngine
extends java.lang.Object

Instances of this class are able to replace all variables by their values in a given text

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	CONTROL_ELSE
protected static java.lang.String	CONTROL_ENDIF
protected static java.lang.String	CONTROL_IF
protected static java.lang.String	CONTROL_IFDEF
protected static java.lang.Character	CONTROL_INDICATOR
protected static java.lang.Character	DEFAULT_FUNCPARAM_END
protected static java.lang.Character	DEFAULT_FUNCPARAM_START
protected static java.lang.Character	DEFAULT_PARAM_SEPARATOR
protected static java.lang.Character	DEFAULT_TEXT_DELIMITER
protected static java.lang.Character	DEFAULT_VAR_END_DELIMITER
protected static java.lang.Character	DEFAULT_VAR_START_DELIMITER
protected static int	EMPTY_CACHE

Constructor Summary

Constructors

Constructor and Description
TextEngine(VariableResolver varResolver) Initializes the new created instance with the given objects for resolving variable and function names to values.
TextEngine(VariableResolver varResolver, FunctionResolver funcResolver) Initializes the new created instance with the given objects for resolving variable and function names to values.

Method Summary

Modifier and Type	Method and Description
void	allowMissingPlaceholders() Allows placeholders that cannot be resolved by the variable resolver.
protected java.lang.String	asString(java.lang.Object anObject)
protected void	checkEndAfterFunction(java.lang.String funcName)
protected void	checkFunctionEnd(java.lang.String funcName)
protected void	checkFunctionStart(java.lang.String funcName)
protected void	checkParameterCount(java.lang.String funcName, int expected, int actual)
java.lang.String	completeText(java.lang.String text) Returns the given text, after replaceing all placeholders with according text.
protected void	copyText()
protected java.lang.String	evaluateControl()
protected java.lang.String	evaluateControlELSE()
protected java.lang.String	evaluateControlENDIF()
protected java.lang.String	evaluateControlIF()
protected java.lang.String	evaluateControlIFDEF()
protected java.lang.String	evaluateFunction(java.lang.String funcName)
protected java.lang.String	evaluateFunction(java.lang.String funcName, java.util.List<java.lang.String> parameter)
protected java.lang.String	evaluatePlaceholder(java.lang.String varName)
void	forbidMissingPlaceholders() Forbids placeholders that cannot be resolved by the variable resolver.
protected int	getCharCache()
protected java.lang.Character	getControlIndicator()
protected java.util.Stack<Bool>	getExecutionControl()
protected java.lang.Character	getFunctionParameterEnd()
protected java.lang.String	getFunctionParameterName() Returns the next name for a function parameter.
protected java.util.List<java.lang.String>	getFunctionParameters()
protected java.lang.Character	getFunctionParameterSeparator()
protected java.lang.Character	getFunctionParameterStart()
FunctionResolver	getFunctionResolver() Returns the function resolver
protected java.lang.String	getIndentationFiller()
protected java.lang.Character	getNextChar()
protected boolean	getNextCharFilled()
protected java.lang.String	getPlaceholderName()
protected java.lang.String	getPlaceholderValue()
protected java.io.StringWriter	getResultBuffer()
protected java.io.StringReader	getSourceBuffer()
java.lang.String	getSpecialNameCharacters() Returns all extra charcters, that are allowed in placeholder names.
protected java.lang.String	getTextConstant()
protected java.lang.Character	getTextDelimiter()
java.lang.Character	getVarEndDelimiter() Returns the delimiter that marks the end of a variable
VariableResolver	getVariableResolver() Returns the variable resolver
java.lang.Character	getVarStartDelimiter() Returns the delimiter that marks the start of a variable
java.lang.Character	getVarStartPrefix() Returns the character that is specified as prefix of the placeholder delimiter or null, if none is used.
protected boolean	hasDelimiterPrefix()
protected boolean	hasMoreChars()
protected void	initializeBuffers(java.lang.String text)
protected void	initializeResultBuffer(int initialCapacity)
protected void	initializeSourceBuffer(java.lang.String source)
protected boolean	isConditionalControlOn()
protected boolean	isDefinedPlaceholder(java.lang.String varName)
protected boolean	isIndentationOn()
protected boolean	isInsertionStart(java.lang.Character character)
protected boolean	isNextCharBufferEmpty()
protected boolean	isValidPlaceholderNameCharacter(char ch)
protected boolean	isWritingOn()
protected java.lang.Character	nextChar()
protected java.lang.Character	nextCharacter() This is a convinient method for retreiving the next character, without always catching IOException.
protected void	putBackNextChar()
protected void	readAhead()
protected void	readNext()
protected void	removeLastWritingSwitch()
protected java.lang.String	resultString()
protected void	setCharCache(int newValue)
protected void	setExecutionControl(java.util.Stack<Bool> newValue)
void	setFunctionResolver(FunctionResolver fr) Sets the function resolver
void	setIndentation(int indentSize) Sets the number of spaces a text must be indented.
protected void	setIndentationFiller(java.lang.String newValue)
protected void	setNextChar(java.lang.Character ch)
protected void	setNextCharFilled(boolean flag)
protected void	setResultBuffer(java.io.StringWriter rb)
protected void	setSourceBuffer(java.io.StringReader sb)
void	setSpecialNameCharacters(java.lang.String newValue) Sets all extra charcters, that are allowed in placeholder names.
void	setVarEndDelimiter(char newValue) Sets the character that indicates the end of a placeholder or directive to the specified value.
void	setVarEndDelimiter(java.lang.Character newValue) Sets the delimiter that marks the end of a variable
void	setVariableResolver(VariableResolver vr) Sets the variable resolver
void	setVarStartDelimiter(char newValue) Sets the character that indicates the start of a placeholder or directive to the specified value.
void	setVarStartDelimiter(java.lang.Character newValue) Sets the delimiter that marks the start of a variable
void	setVarStartPrefix(java.lang.Character prefix) Sets the character that is is used as prefix of the placeholder start delimiter.
protected java.lang.Character	skipSpaces()
protected StringUtil	strUtil()
protected boolean	supressMissingVariableException()
protected void	supressMissingVariableException(boolean newValue)
protected void	switchWritingOff()
protected void	switchWritingOn()
protected void	switchWritingTo(Bool bool)
protected void	toggleWritingSwitch()
void	useDollarCurlyBrackets() Sets the delimiters to ${}
protected void	writeToResultBuffer(char ch)
protected void	writeToResultBuffer(java.lang.String text)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VAR_START_DELIMITER

protected static final java.lang.Character DEFAULT_VAR_START_DELIMITER

DEFAULT_VAR_END_DELIMITER

protected static final java.lang.Character DEFAULT_VAR_END_DELIMITER

DEFAULT_TEXT_DELIMITER

protected static final java.lang.Character DEFAULT_TEXT_DELIMITER

DEFAULT_PARAM_SEPARATOR

protected static final java.lang.Character DEFAULT_PARAM_SEPARATOR

DEFAULT_FUNCPARAM_START

protected static final java.lang.Character DEFAULT_FUNCPARAM_START

DEFAULT_FUNCPARAM_END

protected static final java.lang.Character DEFAULT_FUNCPARAM_END

CONTROL_INDICATOR

protected static final java.lang.Character CONTROL_INDICATOR

CONTROL_IF

protected static final java.lang.String CONTROL_IF

See Also:

Constant Field Values

CONTROL_ELSE

protected static final java.lang.String CONTROL_ELSE

See Also:

Constant Field Values

CONTROL_ENDIF

protected static final java.lang.String CONTROL_ENDIF

See Also:

Constant Field Values

CONTROL_IFDEF

protected static final java.lang.String CONTROL_IFDEF

See Also:

Constant Field Values

EMPTY_CACHE

protected static final int EMPTY_CACHE

See Also:

Constant Field Values

Constructor Detail

TextEngine

public TextEngine(VariableResolver varResolver)

Initializes the new created instance with the given objects for resolving variable and function names to values.

Parameters:

varResolver - The object that provides values for variables

See Also:

setVariableResolver( VariableResolver )

TextEngine

public TextEngine(VariableResolver varResolver,
                  FunctionResolver funcResolver)

Initializes the new created instance with the given objects for resolving variable and function names to values.

Parameters:

varResolver - The object that provides values for variables

funcResolver - The object that provides values for function calls

See Also:

setVariableResolver( VariableResolver ), setFunctionResolver( FunctionResolver )

Method Detail

getVariableResolver

public VariableResolver getVariableResolver()

Returns the variable resolver

setVariableResolver

public void setVariableResolver(VariableResolver vr)

Sets the variable resolver

getFunctionResolver

public FunctionResolver getFunctionResolver()

Returns the function resolver

setFunctionResolver

public void setFunctionResolver(FunctionResolver fr)

Sets the function resolver

getVarStartPrefix

public java.lang.Character getVarStartPrefix()

Returns the character that is specified as prefix of the placeholder delimiter or null, if none is used.
Example: %varName% -> Has no prefix, this method returns null
${varName} -> Uses '$' as prefix, this method returns Character('$')

setVarStartPrefix

public void setVarStartPrefix(java.lang.Character prefix)

Sets the character that is is used as prefix of the placeholder start delimiter.
Set to null, if no prefix is desired.

Parameters:

prefix - The prefix character of null to use none.

getVarStartDelimiter

public java.lang.Character getVarStartDelimiter()

Returns the delimiter that marks the start of a variable

setVarStartDelimiter

public void setVarStartDelimiter(java.lang.Character newValue)

Sets the delimiter that marks the start of a variable

getVarEndDelimiter

public java.lang.Character getVarEndDelimiter()

Returns the delimiter that marks the end of a variable

setVarEndDelimiter

public void setVarEndDelimiter(java.lang.Character newValue)

Sets the delimiter that marks the end of a variable

getSpecialNameCharacters

public java.lang.String getSpecialNameCharacters()

Returns all extra charcters, that are allowed in placeholder names.
By default only [A-Z][a-z][0-9] and '_' are allowed.

setSpecialNameCharacters

public void setSpecialNameCharacters(java.lang.String newValue)

Sets all extra charcters, that are allowed in placeholder names.
By default only [A-Z][a-z][0-9] and '_' are allowed.

completeText

public java.lang.String completeText(java.lang.String text)
                              throws TextReplacementException

Returns the given text, after replaceing all placeholders with according text.

Parameters:

text - The input text containing placeholders.

Returns:

the given input text with all placeholders replaced

Throws:

TextReplacementException

setIndentation

public void setIndentation(int indentSize)

Sets the number of spaces a text must be indented.

Parameters:

indentSize - the number of indentation spaces ( 0 means no indentation )

setVarStartDelimiter

public void setVarStartDelimiter(char newValue)

Sets the character that indicates the start of a placeholder or directive to the specified value.

setVarEndDelimiter

public void setVarEndDelimiter(char newValue)

Sets the character that indicates the end of a placeholder or directive to the specified value.

useDollarCurlyBrackets

public void useDollarCurlyBrackets()

Sets the delimiters to ${}

Placeholders then must look like ${varName}.

allowMissingPlaceholders

public void allowMissingPlaceholders()

Allows placeholders that cannot be resolved by the variable resolver. That means, that the placeholder's name itself will be placed in the text.
The default behaviour of a TextEngine is to throw an exception, if a placeholder can't be resolved.

forbidMissingPlaceholders

public void forbidMissingPlaceholders()

Forbids placeholders that cannot be resolved by the variable resolver. That means, that an exception will be thrown, if a placeholder can't be resolved.
The default behaviour of a TextEngine is to throw an exception, if a placeholder can't be resolved.

initializeResultBuffer

protected void initializeResultBuffer(int initialCapacity)

initializeSourceBuffer

protected void initializeSourceBuffer(java.lang.String source)

initializeBuffers

protected void initializeBuffers(java.lang.String text)

copyText

protected void copyText()
                 throws TextReplacementException

Throws:

TextReplacementException

isInsertionStart

protected boolean isInsertionStart(java.lang.Character character)

hasDelimiterPrefix

protected boolean hasDelimiterPrefix()

writeToResultBuffer

protected void writeToResultBuffer(java.lang.String text)

writeToResultBuffer

protected void writeToResultBuffer(char ch)

getPlaceholderName

protected java.lang.String getPlaceholderName()

getPlaceholderValue

protected java.lang.String getPlaceholderValue()
                                        throws TextReplacementException

Throws:

TextReplacementException

checkEndAfterFunction

protected void checkEndAfterFunction(java.lang.String funcName)
                              throws TextReplacementException

Throws:

TextReplacementException

checkFunctionStart

protected void checkFunctionStart(java.lang.String funcName)
                           throws TextReplacementException

Throws:

TextReplacementException

checkFunctionEnd

protected void checkFunctionEnd(java.lang.String funcName)
                         throws TextReplacementException

Throws:

TextReplacementException

checkParameterCount

protected void checkParameterCount(java.lang.String funcName,
                                   int expected,
                                   int actual)
                            throws TextReplacementException

Throws:

TextReplacementException

evaluateControlIF

protected java.lang.String evaluateControlIF()
                                      throws TextReplacementException

Throws:

TextReplacementException

evaluateControlIFDEF

protected java.lang.String evaluateControlIFDEF()
                                         throws TextReplacementException

Throws:

TextReplacementException

evaluateControlELSE

protected java.lang.String evaluateControlELSE()
                                        throws TextReplacementException

Throws:

TextReplacementException

evaluateControlENDIF

protected java.lang.String evaluateControlENDIF()
                                         throws TextReplacementException

Throws:

TextReplacementException

evaluateControl

protected java.lang.String evaluateControl()
                                    throws TextReplacementException

Throws:

TextReplacementException

getTextConstant

protected java.lang.String getTextConstant()

asString

protected java.lang.String asString(java.lang.Object anObject)

evaluatePlaceholder

protected java.lang.String evaluatePlaceholder(java.lang.String varName)
                                        throws UnknownVariableException

Throws:

UnknownVariableException

isDefinedPlaceholder

protected boolean isDefinedPlaceholder(java.lang.String varName)

getFunctionParameters

protected java.util.List<java.lang.String> getFunctionParameters()
                                                          throws TextReplacementException

Throws:

TextReplacementException

getFunctionParameterName

protected java.lang.String getFunctionParameterName()
                                             throws TextReplacementException

Returns the next name for a function parameter.

Throws:

TextReplacementException

evaluateFunction

protected java.lang.String evaluateFunction(java.lang.String funcName,
                                            java.util.List<java.lang.String> parameter)
                                     throws UnknownFunctionException,
                                            InvalidParameterException

Throws:

UnknownFunctionException

InvalidParameterException

evaluateFunction

protected java.lang.String evaluateFunction(java.lang.String funcName)
                                     throws TextReplacementException

Throws:

TextReplacementException

readAhead

protected void readAhead()
                  throws java.io.IOException

Throws:

java.io.IOException

readNext

protected void readNext()
                 throws java.io.IOException

Throws:

java.io.IOException

hasMoreChars

protected boolean hasMoreChars()

nextChar

protected java.lang.Character nextChar()
                                throws java.io.IOException

Throws:

java.io.IOException

nextCharacter

protected java.lang.Character nextCharacter()

This is a convinient method for retreiving the next character, without always catching IOException. It should only be used in combination with hasMoreChars().

putBackNextChar

protected void putBackNextChar()

isNextCharBufferEmpty

protected boolean isNextCharBufferEmpty()

skipSpaces

protected java.lang.Character skipSpaces()

resultString

protected java.lang.String resultString()

getFunctionParameterStart

protected java.lang.Character getFunctionParameterStart()

getFunctionParameterEnd

protected java.lang.Character getFunctionParameterEnd()

getFunctionParameterSeparator

protected java.lang.Character getFunctionParameterSeparator()

getTextDelimiter

protected java.lang.Character getTextDelimiter()

isValidPlaceholderNameCharacter

protected boolean isValidPlaceholderNameCharacter(char ch)

getControlIndicator

protected java.lang.Character getControlIndicator()

isIndentationOn

protected boolean isIndentationOn()

isWritingOn

protected boolean isWritingOn()

isConditionalControlOn

protected boolean isConditionalControlOn()

removeLastWritingSwitch

protected void removeLastWritingSwitch()
                                throws java.util.EmptyStackException

Throws:

java.util.EmptyStackException

switchWritingTo

protected void switchWritingTo(Bool bool)

toggleWritingSwitch

protected void toggleWritingSwitch()
                            throws java.util.EmptyStackException

Throws:

java.util.EmptyStackException

switchWritingOn

protected void switchWritingOn()

switchWritingOff

protected void switchWritingOff()

strUtil

protected StringUtil strUtil()

getSourceBuffer

protected java.io.StringReader getSourceBuffer()

setSourceBuffer

protected void setSourceBuffer(java.io.StringReader sb)

getResultBuffer

protected java.io.StringWriter getResultBuffer()

setResultBuffer

protected void setResultBuffer(java.io.StringWriter rb)

getNextChar

protected java.lang.Character getNextChar()

setNextChar

protected void setNextChar(java.lang.Character ch)

getNextCharFilled

protected boolean getNextCharFilled()

setNextCharFilled

protected void setNextCharFilled(boolean flag)

getCharCache

protected int getCharCache()

setCharCache

protected void setCharCache(int newValue)

getExecutionControl

protected java.util.Stack<Bool> getExecutionControl()

setExecutionControl

protected void setExecutionControl(java.util.Stack<Bool> newValue)

supressMissingVariableException

protected boolean supressMissingVariableException()

supressMissingVariableException

protected void supressMissingVariableException(boolean newValue)

getIndentationFiller

protected java.lang.String getIndentationFiller()

setIndentationFiller

protected void setIndentationFiller(java.lang.String newValue)