com.jrefinery.report.function
Class ReportPropertyFunction

java.lang.Object
  extended bycom.jrefinery.report.function.AbstractFunction
      extended bycom.jrefinery.report.function.ReportPropertyFunction
All Implemented Interfaces:
java.lang.Cloneable, java.util.EventListener, Expression, Function, ReportListener, java.io.Serializable

Deprecated. ReportProperties are now retrieved from the report state.

public class ReportPropertyFunction
extends AbstractFunction
implements java.io.Serializable

A report function that returns a property that has been set for a report.

There are some properties that are defined for all reports: "report.name" and "report.date".

You can add arbitrary properties to a report using the setProperty method.

Author:
David Gilbert
See Also:
Serialized Form

Field Summary
static java.lang.String REPORTPROPERTY_PROPERTY
          Deprecated. Literal text for the 'reportProperty' property.
 
Fields inherited from interface com.jrefinery.report.function.Expression
AUTOACTIVATE_PROPERTY
 
Constructor Summary
ReportPropertyFunction()
          Deprecated. Default constructor (intended for use by the SAX handler only).
ReportPropertyFunction(java.lang.String name, java.lang.String propertyName)
          Deprecated. Constructs a new function.
 
Method Summary
 java.lang.String getField()
          Deprecated. Returns the name of the report property that the function accesses.
 java.lang.Object getValue()
          Deprecated. Returns the function's value.
 void groupFinished(ReportEvent event)
          Deprecated. Updates the property value of this function.
 void groupStarted(ReportEvent event)
          Deprecated. Updates the property value of this function.
 void initialize()
          Deprecated. Initialises the function.
 void itemsAdvanced(ReportEvent event)
          Deprecated. Updates the property value of this function.
 void itemsFinished(ReportEvent event)
          Deprecated. Updates the property value of this function.
 void itemsStarted(ReportEvent event)
          Deprecated. Updates the property value of this function.
 void pageFinished(ReportEvent event)
          Deprecated. Updates the property value of this function.
 void pageStarted(ReportEvent event)
          Deprecated. Updates the property value of this function.
 void reportFinished(ReportEvent event)
          Deprecated. Updates the property value of this function.
 void reportStarted(ReportEvent event)
          Deprecated. Updates the property value of this function.
 void setField(java.lang.String field)
          Deprecated. Sets the name of the report property that the function accesses.
 
Methods inherited from class com.jrefinery.report.function.AbstractFunction
clone, getDataRow, getDependencyLevel, getInstance, getName, getProperties, getProperty, getProperty, isActive, reportDone, reportInitialized, setDataRow, setDependencyLevel, setName, setProperties, setProperty
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

REPORTPROPERTY_PROPERTY

public static final java.lang.String REPORTPROPERTY_PROPERTY
Deprecated. 
Literal text for the 'reportProperty' property.

See Also:
Constant Field Values
Constructor Detail

ReportPropertyFunction

public ReportPropertyFunction()
Deprecated. 
Default constructor (intended for use by the SAX handler only).


ReportPropertyFunction

public ReportPropertyFunction(java.lang.String name,
                              java.lang.String propertyName)
Deprecated. 
Constructs a new function.

Parameters:
name - the function name.
propertyName - the property name.
Method Detail

reportStarted

public void reportStarted(ReportEvent event)
Deprecated. 
Updates the property value of this function.

Specified by:
reportStarted in interface ReportListener
Overrides:
reportStarted in class AbstractFunction
Parameters:
event - the event.

reportFinished

public void reportFinished(ReportEvent event)
Deprecated. 
Updates the property value of this function.

Specified by:
reportFinished in interface ReportListener
Overrides:
reportFinished in class AbstractFunction
Parameters:
event - the event.

pageStarted

public void pageStarted(ReportEvent event)
Deprecated. 
Updates the property value of this function.

Specified by:
pageStarted in interface ReportListener
Overrides:
pageStarted in class AbstractFunction
Parameters:
event - the event.

pageFinished

public void pageFinished(ReportEvent event)
Deprecated. 
Updates the property value of this function.

Specified by:
pageFinished in interface ReportListener
Overrides:
pageFinished in class AbstractFunction
Parameters:
event - the event.

groupStarted

public void groupStarted(ReportEvent event)
Deprecated. 
Updates the property value of this function.

Specified by:
groupStarted in interface ReportListener
Overrides:
groupStarted in class AbstractFunction
Parameters:
event - the event.

groupFinished

public void groupFinished(ReportEvent event)
Deprecated. 
Updates the property value of this function.

Specified by:
groupFinished in interface ReportListener
Overrides:
groupFinished in class AbstractFunction
Parameters:
event - the event.

itemsAdvanced

public void itemsAdvanced(ReportEvent event)
Deprecated. 
Updates the property value of this function.

Specified by:
itemsAdvanced in interface ReportListener
Overrides:
itemsAdvanced in class AbstractFunction
Parameters:
event - the event.

itemsStarted

public void itemsStarted(ReportEvent event)
Deprecated. 
Updates the property value of this function.

Specified by:
itemsStarted in interface ReportListener
Overrides:
itemsStarted in class AbstractFunction
Parameters:
event - the event.

itemsFinished

public void itemsFinished(ReportEvent event)
Deprecated. 
Updates the property value of this function.

Specified by:
itemsFinished in interface ReportListener
Overrides:
itemsFinished in class AbstractFunction
Parameters:
event - the event.

getValue

public java.lang.Object getValue()
Deprecated. 
Returns the function's value.

Specified by:
getValue in interface Expression
Returns:
the function value.

getField

public java.lang.String getField()
Deprecated. 
Returns the name of the report property that the function accesses.

I recommend renaming this method getReportPropertyName() (DG);

Returns:
The name of the report property.

setField

public void setField(java.lang.String field)
Deprecated. 
Sets the name of the report property that the function accesses.

I recommend renaming this method setReportPropertyName() (DG);

Parameters:
field - The report property name.

initialize

public void initialize()
                throws FunctionInitializeException
Deprecated. 
Initialises the function.

Specified by:
initialize in interface Expression
Overrides:
initialize in class AbstractFunction
Throws:
FunctionInitializeException - if the function is not fully initialised.