Save This Page
Home » pentaho-reporting-engine-classic-0.8.10 » org » jfree » report » filter » [javadoc | source]
org.jfree.report.filter
public class: MessageFormatFilter [javadoc | source]
java.lang.Object
   org.jfree.report.filter.MessageFormatFilter

All Implemented Interfaces:
    DataSource

A filter that formats values from a data source to a string representation.

This filter will format objects using a java.text.MessageFormat to create the string representation for the number obtained from the datasource.

Constructor:
 public MessageFormatFilter() 
Method from org.jfree.report.filter.MessageFormatFilter Summary:
clone,   getFormatString,   getNullString,   getValue,   setFormatString,   setNullString
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.jfree.report.filter.MessageFormatFilter Detail:
 public Object clone() throws CloneNotSupportedException 
    Clones this DataSource.
 public String getFormatString() 
    Returns the format string used in the message format.
 public String getNullString() 
    Returns the replacement text if one of the referenced fields in the message is null.
 public Object getValue(ExpressionRuntime runtime,
    Element element) 
    Returns the formatted string. The value is read using the data source given and formated using the formatter of this object. The formating is guaranteed to completly form the object to an string or to return the defined NullValue.

    If format, datasource or object are null, the NullValue is returned.

 public  void setFormatString(String format) 
 public  void setNullString(String nullString) 
    Defines the replacement text that is used, if one of the referenced fields in the message is null.