org.pentaho.reporting.engine.classic.core.filter

Class DecimalFormatParser

java.lang.Object

org.pentaho.reporting.engine.classic.core.filter.FormatParser

org.pentaho.reporting.engine.classic.core.filter.NumberFormatParser

org.pentaho.reporting.engine.classic.core.filter.DecimalFormatParser

All Implemented Interfaces:

Serializable, Cloneable, DataFilter, DataSource, DataTarget

public class DecimalFormatParser
extends NumberFormatParser

A filter that parses string values from a data source to a number using the decimal numeric system as base.

This filter will parse strings using a java.text.DecimalFormat to create the numeric value for the string from the datasource. If the datasource does not return a string, the required string is formed by applying String.valueOf (Object).

If the string read from the datasource could not be parsed into a number, the NullValue defined by setNullValue(Object) is returned.

Author:

Thomas Morgner

See Also:

NumberFormat, Number, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DecimalFormatParser() DefaultConstructor, this object is initialized using a DecimalFormat with the default pattern for this locale.

Method Summary

Modifier and Type	Method and Description
DecimalFormat	getDecimalFormat() Returns the format for the filter.
String	getFormatString() Synthesizes a pattern string that represents the current state of this Format object.
String	getLocalizedFormatString() Synthesizes a localized pattern string that represents the current state of this Format object.
Object	getValue(ExpressionRuntime runtime, ReportElement element) Returns the formatted string.
boolean	isKeepState() Defines, whether the filter should keep its state, if a locale change is detected.
void	setDecimalFormat(DecimalFormat format) Sets the format for the filter.
void	setFormatString(String format) Applies a format string to the internal DecimalFormat instance.
void	setFormatter(Format format) Sets the format for the filter.
void	setKeepState(boolean keepState) Defines, whether the filter should keep its state, if a locale change is detected.
void	setLocalizedFormatString(String format) Applies a localised format string to the internal DecimalFormat instance.

Methods inherited from class org.pentaho.reporting.engine.classic.core.filter.NumberFormatParser

getMaximumFractionDigits, getMaximumIntegerDigits, getMinimumFractionDigits, getMinimumIntegerDigits, getNumberFormat, isGroupingUsed, setGroupingUsed, setMaximumFractionDigits, setMaximumIntegerDigits, setMinimumFractionDigits, setMinimumIntegerDigits, setNumberFormat

Methods inherited from class org.pentaho.reporting.engine.classic.core.filter.FormatParser

clone, getDataSource, getFormatter, getNullValue, setDataSource, setNullValue

Methods inherited from class java.lang.Object

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

Constructor Detail

DecimalFormatParser

public DecimalFormatParser()

DefaultConstructor, this object is initialized using a DecimalFormat with the default pattern for this locale.

Method Detail

getDecimalFormat

public DecimalFormat getDecimalFormat()

Returns the format for the filter. The DecimalFormatParser has only DecimalFormat objects assigned.

Returns:

the formatter.

setDecimalFormat

public void setDecimalFormat(DecimalFormat format)

Sets the format for the filter.

Parameters:

format - the format.

Throws:

NullPointerException - if the given format is null.

setFormatter

public void setFormatter(Format format)

Sets the format for the filter. If the given format is no Decimal format, a ClassCastException is thrown

Overrides:

setFormatter in class NumberFormatParser

Parameters:

format - The format.

Throws:

NullPointerException - if the given format is null

ClassCastException - if the format is no decimal format

getFormatString

public String getFormatString()

Synthesizes a pattern string that represents the current state of this Format object.

Returns:

the pattern string of the format object contained in this filter.

setFormatString

public void setFormatString(String format)

Applies a format string to the internal DecimalFormat instance.

Parameters:

format - the format string.

getLocalizedFormatString

public String getLocalizedFormatString()

Synthesizes a localized pattern string that represents the current state of this Format object.

Returns:

the localized pattern string of the format-object.

setLocalizedFormatString

public void setLocalizedFormatString(String format)

Applies a localised format string to the internal DecimalFormat instance.

Parameters:

format - the format string.

isKeepState

public boolean isKeepState()

Defines, whether the filter should keep its state, if a locale change is detected. This will effectivly disable the locale update.

Returns:

true, if the locale should not update the DateSymbols, false otherwise.

setKeepState

public void setKeepState(boolean keepState)

Defines, whether the filter should keep its state, if a locale change is detected. This will effectivly disable the locale update.

Parameters:

keepState - set to true, if the locale should not update the DateSymbols, false otherwise.

getValue

public Object getValue(ExpressionRuntime runtime,
                       ReportElement 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.

Specified by:

getValue in interface DataSource

Overrides:

getValue in class FormatParser

Parameters:

runtime - the expression runtime that is used to evaluate formulas and expressions when computing the value of this filter.

element -

Returns:

The formatted value.