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

Class DateFieldType

java.lang.Object

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

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

All Implemented Interfaces:

Serializable, Cloneable, DataSource, RawDataSource, RotatableText, ElementType

public class DateFieldType
extends AbstractElementType
implements RawDataSource, RotatableText

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DateFieldType.DateFieldTypeContext

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_FORMAT
static DateFieldType	INSTANCE

Constructor Summary

Constructors

Constructor	Description
DateFieldType()

Method Summary

Modifier and Type	Method	Description
Object	getDesignValue(ExpressionRuntime runtime, ReportElement element)	Compute a design-time value.
FormatSpecification	getFormatString(ExpressionRuntime runtime, ReportElement element, FormatSpecification formatSpecification)	Returns information about the formatstring that was used to transform a raw-value into a formatted text.
Object	getRawValue(ExpressionRuntime runtime, ReportElement element)	Returns the unformated raw value.
Object	getValue(ExpressionRuntime runtime, ReportElement element)	Returns the current value for the data source.

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

clone, configureDesignTimeDefaults, create, equals, getId, getMetaData, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.pentaho.reporting.engine.classic.core.filter.DataSource

clone

Methods inherited from interface org.pentaho.reporting.engine.classic.core.filter.types.RotatableText

rotate

Field Detail

INSTANCE

public static final DateFieldType INSTANCE

DEFAULT_FORMAT

public static final String DEFAULT_FORMAT

See Also:

Constant Field Values

Constructor Detail

DateFieldType

public DateFieldType()

Method Detail

getDesignValue

public Object getDesignValue(ExpressionRuntime runtime,
                             ReportElement element)

Description copied from interface: ElementType

Compute a design-time value. This value will be displayed when editing the element in the Pentaho Report Designer. If there is not enough data available to produce a sensible output, return a mock-object so that the user can interact with the element in a sensible fashion.

When the element is called, all style and attribute expressions have been resolved and can be accessed via the normal static style and attribute accessor methods. If the content of your element depends on style information, the fully computed style must be retrieved via the .Element#getComputedStyle() method. The local style-sheet for the element may not have all information.

Specified by:

getDesignValue in interface ElementType

Parameters:

runtime - the expression runtime holding the current report state.

element - the element.

Returns:

the computed value.

getRawValue

public Object getRawValue(ExpressionRuntime runtime,
                          ReportElement element)

Returns the unformated raw value. Whether that raw value is useable for the export is beyond the scope of this API definition, but providing access to Number or Date objects is a good idea.

Specified by:

getRawValue in interface RawDataSource

Parameters:

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

element -

Returns:

the raw data.

getFormatString

public FormatSpecification getFormatString(ExpressionRuntime runtime,
                                           ReportElement element,
                                           FormatSpecification formatSpecification)

Returns information about the formatstring that was used to transform a raw-value into a formatted text. Not all elements will make use of a format-string. These elements will return .classic.core.filter.FormatSpecification#TYPE_UNDEFINED in that case.

Specified by:

getFormatString in interface RawDataSource

Parameters:

runtime - the Expression runtime used to possibly compute the raw-value.

element - the element to which this datasource is added.

formatSpecification - the format specification (can be null).

Returns:

a filled format specififcation. If the formatSpecification parameter was not null, this given instance is reused.

getValue

public Object getValue(ExpressionRuntime runtime,
                       ReportElement element)

Returns the current value for the data source.

Specified by:

getValue in interface DataSource

Parameters:

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

element - the element from which to read attribute.

Returns:

the value.