org.pentaho.reporting.engine.classic.core.metadata
Interface ExpressionMetaData

All Superinterfaces:

MetaData

All Known Implementing Classes:

DefaultExpressionMetaData

public interface ExpressionMetaData
extends MetaData

Provides meta-data for functions. This is basically an extension to the classical bean-info class, with some additional documentations and properties, but without the setter methods (so this class is immutable) and without the event-handler support (as functions cannot support event-handlers).

The ExpressionMetaData makes the assumption, that the expression itself is a bean and that every property descriptor that is retrieved here can also be retrieved using the standard bean-methods using a plain BeanInfo object.

Author:

Thomas Morgner

Method Summary

BeanInfo	getBeanDescriptor()
Class	getExpressionType()
Image	getIcon(Locale locale, int iconKind)
ExpressionPropertyMetaData	getPropertyDescription(String name)
ExpressionPropertyMetaData[]	getPropertyDescriptions()
String[]	getPropertyNames()
Class	getResultType()
boolean	isElementLayoutProcessor() Checks whether the main purpose of the expression is to modify the layout of the report.
boolean	isGlobalLayoutProcessor() Checks whether the main purpose of the expression is to modify the layout of the report.
boolean	isStatefull()

Methods inherited from interface org.pentaho.reporting.engine.classic.core.metadata.MetaData

getCompatibilityLevel, getDeprecationMessage, getDescription, getDisplayName, getGrouping, getGroupingOrdinal, getItemOrdinal, getMetaAttribute, getName, isDeprecated, isExperimental, isExpert, isHidden, isPreferred

Method Detail

isElementLayoutProcessor

boolean isElementLayoutProcessor()

Checks whether the main purpose of the expression is to modify the layout of the report. This method returns true, if the expression modifies one or more named elements.

Returns:

true, if this is a layout-processor that modifies named elements.

isGlobalLayoutProcessor

boolean isGlobalLayoutProcessor()

Checks whether the main purpose of the expression is to modify the layout of the report. This method returns true, if the expression modifies the global layout only.

Returns:

true, if this is a layout-processor that modifies the global layout.

isStatefull

boolean isStatefull()

getIcon

Image getIcon(Locale locale,
              int iconKind)

getResultType

Class getResultType()

getExpressionType

Class getExpressionType()

getBeanDescriptor

BeanInfo getBeanDescriptor()
                           throws IntrospectionException

Throws:

IntrospectionException

getPropertyNames

String[] getPropertyNames()

getPropertyDescriptions

ExpressionPropertyMetaData[] getPropertyDescriptions()

getPropertyDescription

ExpressionPropertyMetaData getPropertyDescription(String name)