com.jrefinery.report.filter.templates
Class StringFieldTemplate

java.lang.Object
  extended bycom.jrefinery.report.filter.templates.AbstractTemplate
      extended bycom.jrefinery.report.filter.templates.StringFieldTemplate
All Implemented Interfaces:
java.lang.Cloneable, DataRowConnectable, DataSource, java.io.Serializable, Template

public class StringFieldTemplate
extends AbstractTemplate
implements DataRowConnectable

A string field template.

Author:
Thomas Morgner
See Also:
Serialized Form

Constructor Summary
StringFieldTemplate()
          Creates a new string field template.
 
Method Summary
 java.lang.Object clone()
          Clones the template.
 void connectDataRow(DataRow row)
          Connects the 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 value displayed by the field when the data source value is null.
 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 value displayed by the field when the data source value is null.
 
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

StringFieldTemplate

public StringFieldTemplate()
Creates a new string field 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.

getNullValue

public java.lang.String getNullValue()
Returns the value displayed by the field when the data source value is null.

Returns:
A value to represent null.

setNullValue

public void setNullValue(java.lang.String nullValue)
Sets the value displayed by the field when the data source value is null.

Parameters:
nullValue - the value that represents null.

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 the 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.