Class ShowElementByNameFunction
- java.lang.Object
-
- org.pentaho.reporting.engine.classic.core.function.AbstractExpression
-
- org.pentaho.reporting.engine.classic.core.function.AbstractFunction
-
- org.pentaho.reporting.engine.classic.core.function.AbstractElementFormatFunction
-
- org.pentaho.reporting.engine.classic.core.function.ShowElementByNameFunction
-
- All Implemented Interfaces:
Serializable
,Cloneable
,EventListener
,PageEventListener
,ReportListener
,Expression
,Function
,LayoutProcessorFunction
public class ShowElementByNameFunction extends AbstractElementFormatFunction
Deprecated.This can be done easier using style-expressionsThis function hiddes the elements with the name specified in the 'element' parameter, if the given field has one of the values specified in the values array.- Author:
- Thomas Morgner
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ShowElementByNameFunction()
Deprecated.Default Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected boolean
evaluateElement(ReportElement e)
Deprecated.String
getField()
Deprecated.Returns the name of the field from where the compare value is read.ShowElementByNameFunction
getInstance()
Deprecated.Return a completly separated copy of this function.Object[]
getValues()
Deprecated.Returns all known compare values as array.Object
getValues(int index)
Deprecated.Returns one of the values that hide the element.int
getValuesCount()
Deprecated.Returns the number of values in the compare list.void
setField(String field)
Deprecated.Defines the name of the field from where the compare value is read.void
setValues(int index, Object value)
Deprecated.Defines one of the values that hide the element.void
setValues(Object[] values)
Deprecated.Defines all values using the object from the value-array.-
Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractElementFormatFunction
getDependencyLevel, getElement, getValue, groupFinished, groupStarted, isExecutable, itemsAdvanced, itemsFinished, itemsStarted, pageFinished, pageStarted, processBand, processFooterBands, processGroupHeaders, processHeaderBands, processRootBand, recordCacheHit, recordCacheMiss, reportCachePerformance, reportDone, reportFinished, reportInitialized, reportStarted, setElement
-
Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractFunction
summaryRowSelection
-
Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractExpression
clone, getDataRow, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setActive, setDependencyLevel, setName, setPreserve, setRuntime
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.pentaho.reporting.engine.classic.core.function.Expression
clone, getDataRow, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setDependencyLevel, setName, setRuntime
-
Methods inherited from interface org.pentaho.reporting.engine.classic.core.event.ReportListener
summaryRowSelection
-
-
-
-
Method Detail
-
getField
public String getField()
Deprecated.Returns the name of the field from where the compare value is read.- Returns:
- the name of the field.
-
setField
public void setField(String field)
Deprecated.Defines the name of the field from where the compare value is read.- Parameters:
field
- the name of the field.
-
setValues
public void setValues(int index, Object value)
Deprecated.Defines one of the values that hide the element. This defines the value at the given index in the list.- Parameters:
value
- the compare value.index
- the position in the list of all values.
-
getValues
public Object getValues(int index)
Deprecated.Returns one of the values that hide the element. This returns the defined value at the given index in the list.- Parameters:
index
- the position in the list of all values.- Returns:
- the value at the given position.
-
getValues
public Object[] getValues()
Deprecated.Returns all known compare values as array.- Returns:
- the values as array.
-
setValues
public void setValues(Object[] values)
Deprecated.Defines all values using the object from the value-array.- Parameters:
values
- the new list of compare values.
-
getValuesCount
public int getValuesCount()
Deprecated.Returns the number of values in the compare list.- Returns:
- the number of values.
-
evaluateElement
protected boolean evaluateElement(ReportElement e)
Deprecated.- Specified by:
evaluateElement
in classAbstractElementFormatFunction
-
getInstance
public ShowElementByNameFunction getInstance()
Deprecated.Return a completly separated copy of this function. The copy does no longer share any changeable objects with the original function.- Specified by:
getInstance
in interfaceExpression
- Overrides:
getInstance
in classAbstractElementFormatFunction
- Returns:
- a copy of this function.
-
-