org.jfree.report.filter.templates
Class ResourceFieldTemplate

java.lang.Object
  |
  +--org.jfree.report.filter.templates.AbstractTemplate
        |
        +--org.jfree.report.filter.templates.ResourceFieldTemplate

public class ResourceFieldTemplate

extends AbstractTemplate

implements ReportConnectable

A resource field template, which reads a String value from a ResourceBundle.

Author:

Thomas Morgner

See Also:

Serialized Form

Constructor Summary

ResourceFieldTemplate()
Creates a new template.

Method Summary

java.lang.Object	clone() Clones the template.
protected DataRowDataSource	getDataRowDataSource() Returns the datarow data source used in this template.
java.lang.String	getField() Returns the field name.
java.lang.String	getNullValue() Returns the string that represents a null value.
java.lang.String	getResourceIdentifier() Returns the resource class name.
java.lang.Object	getValue() Returns the current value for the data source.
void	registerReportDefinition(ReportDefinition reportDefinition) Connects the connectable to the given report definition.
void	setField(java.lang.String field) Sets the field name.
void	setNullValue(java.lang.String nullValue) Sets the string that represents a null value.
void	setResourceIdentifier(java.lang.String resourceClassName) Sets the resource class name.
void	unregisterReportDefinition(ReportDefinition reportDefinition) Disconnects this ReportConnectable from the report definition.

Methods inherited from class org.jfree.report.filter.templates.AbstractTemplate

getInstance, getName, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceFieldTemplate

public ResourceFieldTemplate()

Creates a new template.

Method Detail

getField

public java.lang.String getField()

Returns the field name.

Returns:

The field name.

setField

public void setField(java.lang.String field)

Sets the field name.

Parameters:

field - the field name.

getResourceIdentifier

public java.lang.String getResourceIdentifier()

Returns the resource class name.

Returns:

The resource class name.

setResourceIdentifier

public void setResourceIdentifier(java.lang.String resourceClassName)
                           throws java.util.MissingResourceException

Sets the resource class name.

Parameters:

resourceClassName - the resource class name.

Throws:

java.util.MissingResourceException - if the resource is missing.

getNullValue

public java.lang.String getNullValue()

Returns the string that represents a null value.

Returns:

The string that represents a null value.

setNullValue

public void setNullValue(java.lang.String nullValue)

Sets the string that represents a null value.

Parameters:

nullValue - the string that represents a null value.

getValue

public java.lang.Object getValue()

Returns the current value for the data source.

Returns:

the value.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clones the template.

Overrides:

clone in class AbstractTemplate

Returns:

the clone.

Throws:

java.lang.CloneNotSupportedException - this should never happen.

registerReportDefinition

public void registerReportDefinition(ReportDefinition reportDefinition)

Connects the connectable to the given report definition.

Specified by:

registerReportDefinition in interface ReportConnectable

Parameters:

reportDefinition - the reportDefinition for this report connectable.

unregisterReportDefinition

public void unregisterReportDefinition(ReportDefinition reportDefinition)

Disconnects this ReportConnectable from the report definition.

Specified by:

unregisterReportDefinition in interface ReportConnectable

Parameters:

reportDefinition - the ReportDefinition.

getDataRowDataSource

protected DataRowDataSource getDataRowDataSource()

Returns the datarow data source used in this template.

Returns:

the datarow data source.