Package org.pentaho.reporting.engine.classic.core.metadata

Interface ExpressionPropertyMetaData

All Superinterfaces:

MetaData

All Known Implementing Classes:

DefaultExpressionPropertyMetaData

public interface ExpressionPropertyMetaData
extends MetaData

Describes the known attributes an element can take.

Author:

Thomas Morgner

Field Summary

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

VALUEROLE_BUNDLE_KEY, VALUEROLE_BUNDLE_NAME, VALUEROLE_CONTENT, VALUEROLE_DATEFORMAT, VALUEROLE_ELEMENT_NAME, VALUEROLE_FIELD, VALUEROLE_FORMULA, VALUEROLE_GROUP, VALUEROLE_MESSAGE, VALUEROLE_NUMBERFORMAT, VALUEROLE_QUERY, VALUEROLE_RESOURCE, VALUEROLE_VALUE

Method Summary

Modifier and Type	Method	Description
PropertyDescriptor	getBeanDescriptor()
PropertyEditor	getEditor()
String[]	getExtraCalculationFields()
default Class<? extends UserDefinedExpressionPropertyReadHandler>	getPropertyReadHandler()
String	getPropertyRole()	Can be one of "Value", "Resource", "Content", "Field", "Group", "Query", "Message", "Bundle-Key", "Bundle-Name", "Name", "ElementName", "DateFormat", "NumberFormat"
Class	getPropertyType()
default Class<? extends ExpressionPropertyWriteHandler>	getPropertyWriteHandler()
String[]	getReferencedElements(Expression expression, Object attributeValue)
String[]	getReferencedFields(Expression expression, Object attributeValue)
String[]	getReferencedGroups(Expression expression, Object attributeValue)
ResourceReference[]	getReferencedResources(Expression expression, Object attributeValue, Element reportElement, org.pentaho.reporting.libraries.resourceloader.ResourceManager resourceManager)
boolean	isComputed()
boolean	isDesignTimeProperty()
boolean	isMandatory()

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

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

Method Detail

getPropertyType

Class getPropertyType()

getPropertyRole

String getPropertyRole()

Can be one of "Value", "Resource", "Content", "Field", "Group", "Query", "Message", "Bundle-Key", "Bundle-Name", "Name", "ElementName", "DateFormat", "NumberFormat"

Returns:

isMandatory

boolean isMandatory()

isDesignTimeProperty

boolean isDesignTimeProperty()

getBeanDescriptor

PropertyDescriptor getBeanDescriptor()

getEditor

PropertyEditor getEditor()

getReferencedFields

String[] getReferencedFields(Expression expression,
                             Object attributeValue)

getReferencedGroups

String[] getReferencedGroups(Expression expression,
                             Object attributeValue)

getReferencedElements

String[] getReferencedElements(Expression expression,
                               Object attributeValue)

getReferencedResources

ResourceReference[] getReferencedResources(Expression expression,
                                           Object attributeValue,
                                           Element reportElement,
                                           org.pentaho.reporting.libraries.resourceloader.ResourceManager resourceManager)

isComputed

boolean isComputed()

getExtraCalculationFields

String[] getExtraCalculationFields()

getPropertyReadHandler

default Class<? extends UserDefinedExpressionPropertyReadHandler> getPropertyReadHandler()

getPropertyWriteHandler

default Class<? extends ExpressionPropertyWriteHandler> getPropertyWriteHandler()