| java.lang.Object
 org.jfree.report.function.AbstractExpression
org.jfree.report.function.TextFormatExpression
| TextFormatExpression | | public class TextFormatExpression extends AbstractExpression (Code) | | A TextFormatExpression uses a java.text.MessageFormat to concat and format one or more values evaluated from an
expression, function or report datasource.
The TextFormatExpression uses the pattern property to define the global format-pattern used when evaluating the
expression. The dataRow fields used to fill the expressions placeholders are defined in a list of properties where
the property-names are numbers. The property counting starts at "0".
The Syntax of the pattern property is explained in the class
java.text.MessageFormat .
Example:
Invoice for your order from {0, date, EEE, MMM d,
yyyy}
printdate
The
org.jfree.report.function.strings.MessageFormatExpression allows to specify named field-references in the
pattern, which greatly simplifies the pattern-definition.
author:
Thomas Morgner |
| Constructor Summary | |
| public | TextFormatExpression()
Default constructor, creates a new unnamed TextFormatExpression. |
| Method Summary | |
| public String | getEncoding()
Returns the defined character encoding that is used to transform the Java-Unicode strings into bytes. | | public String | getField(int index)
Returns the defined field at the given index-position.
Parameters:
index - the position of the field name that should be queried. | | public String[] | getField()
Returns all defined fields as array of strings. | | public int | getFieldCount()
Returns the number of fields defined in this expression. | | protected Object[] | getFieldValues(Object[] retval)
Collects the values of all fields defined in the fieldList.
Parameters:
retval - an optional array that will receive the field values. | | public Expression | getInstance()
Return a completly separated copy of this function. | | public String | getPattern()
Returns the pattern defined for this expression. | | public Object | getValue()
Evaluates the expression by collecting all values defined in the fieldlist from the datarow. | | public boolean | isUrlEncodeResult()
Queries, whether the formatted result-string will be URL encoded. | | public boolean | isUrlEncodeValues()
Queries, whether the values read from the data-row should be URL encoded. | | public void | setEncoding(String encoding)
Defines the character encoding that is used to transform the Java-Unicode strings into bytes. | | public void | setField(int index, String field)
Defines the field in the field-list at the given index. | | public void | setField(String[] fields)
Defines all fields as array. | | public void | setPattern(String pattern)
Defines the pattern for this expression. | | public void | setUrlEncodeResult(boolean urlEncodeResult)
Defines, whether the formatted result-string will be URL encoded. | | public void | setUrlEncodeValues(boolean urlEncode)
Defines, whether the values read from the data-row should be URL encoded. |
| TextFormatExpression | | public TextFormatExpression()(Code) | | Default constructor, creates a new unnamed TextFormatExpression.
|
| getEncoding | | public String getEncoding()(Code) | | Returns the defined character encoding that is used to transform the Java-Unicode strings into bytes.
the encoding. |
| getField | | public String getField(int index)(Code) | | Returns the defined field at the given index-position.
Parameters:
index - the position of the field name that should be queried. the field name at the given position. |
| getField | | public String[] getField()(Code) | | Returns all defined fields as array of strings.
all the fields. |
| getFieldCount | | public int getFieldCount()(Code) | | Returns the number of fields defined in this expression.
the number of fields. |
| getInstance | | public Expression getInstance()(Code) | | Return a completly separated copy of this function. The copy does no longer share any changeable objects with the
original function.
a copy of this function. |
| getPattern | | public String getPattern()(Code) | | Returns the pattern defined for this expression.
the pattern. |
| getValue | | public Object getValue()(Code) | | Evaluates the expression by collecting all values defined in the fieldlist from the datarow. The collected values
are then parsed and formated by the MessageFormat-object.
a string containing the pattern inclusive the formatted values from the datarow |
| isUrlEncodeResult | | public boolean isUrlEncodeResult()(Code) | | Queries, whether the formatted result-string will be URL encoded.
true, if the formatted result will be encoded, false otherwise. |
| isUrlEncodeValues | | public boolean isUrlEncodeValues()(Code) | | Queries, whether the values read from the data-row should be URL encoded.
true, if the values are encoded, false otherwise. |
| setEncoding | | public void setEncoding(String encoding)(Code) | | Defines the character encoding that is used to transform the Java-Unicode strings into bytes.
Parameters:
encoding - the encoding. |
| setField | | public void setField(int index, String field)(Code) | | Defines the field in the field-list at the given index.
Parameters:
index - the position in the list, where the field should be defined.
Parameters:
field - the name of the field. |
| setField | | public void setField(String[] fields)(Code) | | Defines all fields as array. This completely replaces any previously defined fields.
Parameters:
fields - the new list of fields. |
| setPattern | | public void setPattern(String pattern)(Code) | | Defines the pattern for this expression. The pattern syntax is defined by the java.text.MessageFormat object and
the given pattern string has to be valid according to the rules defined there.
Parameters:
pattern - the pattern string |
| setUrlEncodeResult | | public void setUrlEncodeResult(boolean urlEncodeResult)(Code) | | Defines, whether the formatted result-string will be URL encoded.
Parameters:
urlEncodeResult - true, if the formatted result will be encoded, false otherwise. |
| setUrlEncodeValues | | public void setUrlEncodeValues(boolean urlEncode)(Code) | | Defines, whether the values read from the data-row should be URL encoded. Dates and Number objects are never
encoded.
Parameters:
urlEncode - true, if the values from the data-row should be URL encoded before they are passed to theMessageFormat, false otherwise. |
|
|