org.jfree.report.util

Class PropertyLookupParser

public abstract class PropertyLookupParser extends Object implements Serializable

The property lookup parser is used to resolve embedded references to properties within strings.

The default format of the property specification is: ${property-name} where 'property-name is the name of the property. If this construct is found within the text, it is replaced with the value returned from a call to "lookupVariable".

Author: Thomas Morgner

Constructor Summary
protected	PropertyLookupParser() Initializes the parser to the default format of "${..}".

Method Summary
char	getClosingBraceChar() Returns the currently defined closed-brace char.
char	getEscapeChar() Returns the escape char.
char	getMarkerChar() Returns initial property marker char.
char	getOpeningBraceChar() Returns the currently defined opening-brace char.
protected abstract String	lookupVariable(String property) Looks up the property with the given name.
void	setClosingBraceChar(char closingBraceChar) Defines the closing brace character.
void	setEscapeChar(char escapeChar) Defines the escape char.
void	setMarkerChar(char markerChar) Defines initial property marker char.
void	setOpeningBraceChar(char openingBraceChar) Defines the opening brace character.
String	translateAndLookup(String value) Translates the given string and resolves the embedded property references.

Constructor Detail

PropertyLookupParser

protected PropertyLookupParser()

Initializes the parser to the default format of "${..}". The escape char will be a backslash.

Method Detail

getClosingBraceChar

public char getClosingBraceChar()

Returns the currently defined closed-brace char.

Returns: the closed-brace char.

getEscapeChar

public char getEscapeChar()

Returns the escape char.

Returns: the escape char.

getMarkerChar

public char getMarkerChar()

Returns initial property marker char.

Returns: the initial property marker character.

getOpeningBraceChar

public char getOpeningBraceChar()

Returns the currently defined opening-brace char.

Returns: the opening-brace char.

lookupVariable

protected abstract String lookupVariable(String property)

Looks up the property with the given name.

Parameters: property the name of the property to look up.

Returns: the translated value.

setClosingBraceChar

public void setClosingBraceChar(char closingBraceChar)

Defines the closing brace character.

Parameters: closingBraceChar the closed-brace character.

setEscapeChar

public void setEscapeChar(char escapeChar)

Defines the escape char.

Parameters: escapeChar the escape char

setMarkerChar

public void setMarkerChar(char markerChar)

Defines initial property marker char.

Parameters: markerChar the initial property marker character.

setOpeningBraceChar

public void setOpeningBraceChar(char openingBraceChar)

Defines the opening brace character.

Parameters: openingBraceChar the opening-brace character.

translateAndLookup

public String translateAndLookup(String value)

Translates the given string and resolves the embedded property references.

Parameters: value the raw value,

Returns: the fully translated string.