public class ItemMinFunction extends AbstractFunction implements FieldAggregationFunction
field
parameter is required and denotes the name of an
ItemBand-field which gets summed up.
The parameter group
denotes the name of a group. When this group is started, the counter gets reseted to
null.Constructor and Description |
---|
ItemMinFunction()
Constructs an unnamed function.
|
ItemMinFunction(String name)
Constructs a named function.
|
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Clones the expression.
|
String |
getCrosstabFilterGroup() |
String |
getField()
Returns the field used by the function.
|
String |
getGroup()
Returns the group name.
|
Expression |
getInstance()
Return a completly separated copy of this function.
|
Object |
getValue()
Returns the function value, in this case the running total of a specific column in the report's data row.
|
void |
groupStarted(ReportEvent event)
Receives notification that a new group is about to start.
|
void |
itemsAdvanced(ReportEvent event)
Receives notification that a row of data is being processed.
|
void |
reportInitialized(ReportEvent event)
Receives notification that a new report is about to start.
|
void |
setCrosstabFilterGroup(String crosstabFilterGroup) |
void |
setField(String field)
Sets the field name for the function.
|
void |
setGroup(String name)
Sets the group name.
|
void |
summaryRowSelection(ReportEvent event)
A crosstab specific event notifying crosstab-aware functions to select the result for the summary row cell that
will be printed next.
|
groupFinished, itemsFinished, itemsStarted, reportDone, reportFinished, reportStarted
getDataRow, getDependencyLevel, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setActive, setDependencyLevel, setName, setPreserve, setRuntime
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
groupFinished, itemsFinished, itemsStarted, reportDone, reportFinished, reportStarted
getDataRow, getDependencyLevel, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setDependencyLevel, setName, setRuntime
public ItemMinFunction()
public ItemMinFunction(String name)
The field must be defined before using the function.
name
- The function name.public void reportInitialized(ReportEvent event)
Does nothing.
reportInitialized
in interface ReportListener
reportInitialized
in class AbstractFunction
event
- Information about the event.public void groupStarted(ReportEvent event)
groupStarted
in interface ReportListener
groupStarted
in class AbstractFunction
event
- Information about the event.public String getGroup()
getGroup
in interface AggregationFunction
public void setGroup(String name)
If a group is defined, the minimum value is reset to zero at the start of every instance of this group.
setGroup
in interface AggregationFunction
name
- the group name (null permitted).public String getField()
getField
in interface FieldAggregationFunction
public void setField(String field)
setField
in interface FieldAggregationFunction
field
- the field name.public void itemsAdvanced(ReportEvent event)
itemsAdvanced
in interface ReportListener
itemsAdvanced
in class AbstractFunction
event
- Information about the event.public void summaryRowSelection(ReportEvent event)
AbstractFunction
summaryRowSelection
in interface ReportListener
summaryRowSelection
in class AbstractFunction
event
- The report event.public Object getValue()
getValue
in interface Expression
public Expression getInstance()
getInstance
in interface Expression
getInstance
in class AbstractExpression
public Object clone()
AbstractExpression
Expressions maintain no state, cloning is done at the beginning of the report processing to disconnect the expression from any other object space.
clone
in interface Expression
clone
in class AbstractExpression
public String getCrosstabFilterGroup()
getCrosstabFilterGroup
in interface AggregationFunction
public void setCrosstabFilterGroup(String crosstabFilterGroup)
setCrosstabFilterGroup
in interface AggregationFunction