com.jrefinery.report.filter.templates
Class ResourceFieldTemplate

java.lang.Object
  com.jrefinery.report.filter.templates.AbstractTemplate
      com.jrefinery.report.filter.templates.ResourceFieldTemplate

All Implemented Interfaces:

java.lang.Cloneable, DataRowConnectable, DataSource, java.io.Serializable, Template

public class ResourceFieldTemplate

extends AbstractTemplate

implements DataRowConnectable

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.
void	connectDataRow(DataRow row) Connects a DataRow to the data source.
void	disconnectDataRow(DataRow row) Releases the connection to the data row.
java.lang.String	getField() Returns the field name.
java.lang.String	getNullValue() Returns the string that represents a null value.
java.lang.String	getResourceClassName() Returns the resource class name.
java.lang.Object	getValue() Returns the current value for the data source.
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	setResourceClassName(java.lang.String resourceClassName) Sets the resource class name.

Methods inherited from class com.jrefinery.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.

getResourceClassName

public java.lang.String getResourceClassName()

Returns the resource class name.

Returns:

The resource class name.

setResourceClassName

public void setResourceClassName(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.

Specified by:

getValue in interface DataSource

Returns:

the value.

clone

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

Clones the template.

Specified by:

clone in interface DataSource

Overrides:

clone in class AbstractTemplate

Returns:

the clone.

Throws:

java.lang.CloneNotSupportedException - this should never happen.

connectDataRow

public void connectDataRow(DataRow row)
                    throws java.lang.IllegalStateException

Connects a DataRow to the data source.

Specified by:

connectDataRow in interface DataRowConnectable

Parameters:

row - the data row.

Throws:

java.lang.IllegalStateException - if there is already a data row connected.

disconnectDataRow

public void disconnectDataRow(DataRow row)
                       throws java.lang.IllegalStateException

Releases the connection to the data row.

If no data row is connected, an IllegalStateException is thrown to indicate the programming error.

Specified by:

disconnectDataRow in interface DataRowConnectable

Parameters:

row - the data row.

Throws:

java.lang.IllegalStateException - if there is already a data row connected.