Package org.pentaho.reporting.engine.classic.core.function.sys

Class SheetNameFunction

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.sys.SheetNameFunction

All Implemented Interfaces:

Serializable, Cloneable, EventListener, PageEventListener, ReportListener, Expression, Function, LayoutProcessorFunction, StructureFunction

public class SheetNameFunction
extends AbstractElementFormatFunction
implements StructureFunction

Deprecated.

This way of defining a sheetname for elements is deprecated. Sheetnames should be declared or computed directly on the bands by specifiing a sheetname using the "computed-sheetname" style-property.

This function is used to generate sheet names into table exports. Sheet names are generated on page breaks and have different representations depending the export type.
To use this functionnality report configuration must set the property DECALRED_SHEETNAME_FUNCTION_KEY to point to an existing function or property accessible within the report.

As for example using simple report definition:

 <report>
   <configuration>
     <!-- where sheetNameExpression is pointing to a valid function declared in this report -->
     <property name="org.pentaho.reporting.engine.classic.core.targets.table.TableWriter
     .SheetNameFunction">sheetNameExpression</property>
   </configuration>
   ...
 </report>
 

Author:

Cedric Pronzato

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SheetNameFunction()	Deprecated. Default constructor.

Method Summary

Modifier and Type	Method	Description
protected boolean	evaluateElement(ReportElement e)	Deprecated.
int	getProcessingPriority()	Deprecated.
Object	getValue()	Deprecated. Structure functions do not care of the result so this method should never be called.
protected boolean	isExecutable()	Deprecated.
void	reportInitialized(ReportEvent event)	Deprecated. Receives notification that report generation initializes the current run.

Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractElementFormatFunction

getDependencyLevel, getElement, getInstance, groupFinished, groupStarted, itemsAdvanced, itemsFinished, itemsStarted, pageFinished, pageStarted, processBand, processFooterBands, processGroupHeaders, processHeaderBands, processRootBand, recordCacheHit, recordCacheMiss, reportCachePerformance, reportDone, reportFinished, 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, getDependencyLevel, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setDependencyLevel, setName, setRuntime

Methods inherited from interface org.pentaho.reporting.engine.classic.core.event.ReportListener

groupFinished, groupStarted, itemsAdvanced, itemsFinished, itemsStarted, reportDone, reportFinished, reportStarted, summaryRowSelection

Constructor Detail

SheetNameFunction

public SheetNameFunction()

Deprecated.

Default constructor.

Method Detail

reportInitialized

public void reportInitialized(ReportEvent event)

Deprecated.

Description copied from class: AbstractElementFormatFunction

Receives notification that report generation initializes the current run.

The event carries a ReportState.Started state. Use this to initialize the report.

Specified by:

reportInitialized in interface ReportListener

Overrides:

reportInitialized in class AbstractElementFormatFunction

Parameters:

event - The event.

getProcessingPriority

public int getProcessingPriority()

Deprecated.

Specified by:

getProcessingPriority in interface StructureFunction

isExecutable

protected boolean isExecutable()

Deprecated.

Overrides:

isExecutable in class AbstractElementFormatFunction

evaluateElement

protected boolean evaluateElement(ReportElement e)

Deprecated.

Specified by:

evaluateElement in class AbstractElementFormatFunction

getValue

public Object getValue()

Deprecated.

Structure functions do not care of the result so this method should never be called.

Specified by:

getValue in interface Expression

Overrides:

getValue in class AbstractElementFormatFunction

Returns:

null