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

Interface AttributeMetaData

All Superinterfaces:

MetaData

All Known Implementing Classes:

DefaultAttributeMetaData

public interface AttributeMetaData
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
PropertyEditor	getEditor()	This method can return null if there is no property editor registered for this type.
String[]	getExtraCalculationFields()
String	getNameSpace()
String[]	getReferencedFields(ReportElement element, Object attributeValue)
String[]	getReferencedGroups(ReportElement element, Object attributeValue)
ResourceReference[]	getReferencedResources(ReportElement element, org.pentaho.reporting.libraries.resourceloader.ResourceManager resourceManager, Object attributeValue)
Class	getTargetType()
String	getValueRole()	Can be one of "Value", "Resource", "Content", "Field", "Group", "Query", "Message", "Bundle-Key", "Bundle-Name", "Name", "ElementName", "DateFormat", "NumberFormat"
boolean	isBulk()
boolean	isComputed()	Indicates if this attribute is computed.
boolean	isDesignTimeValue()	Indicates whether this attribute is a design-time value.
boolean	isMandatory()
boolean	isTransient()	Indicates whether this attribute should be omitted when element is serialized to disk or written into a PRPT file.

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

getNameSpace

String getNameSpace()

getTargetType

Class getTargetType()

getValueRole

String getValueRole()

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

Returns:

isMandatory

boolean isMandatory()

isComputed

boolean isComputed()

Indicates if this attribute is computed. This indicates that values of the attribute will be computed at runtime and any value set in the element itself is merely there for caching purposes and can be removed before writing the PRPT file, before serializing and before deriving an element.

isTransient

boolean isTransient()

Indicates whether this attribute should be omitted when element is serialized to disk or written into a PRPT file. Only mark attributes as transient which contain values that have been handled elsewhere.

isBulk

boolean isBulk()

isDesignTimeValue

boolean isDesignTimeValue()

Indicates whether this attribute is a design-time value. Such values will not be computed at runtime and any expression given for that attribute will be ignored.

Returns:

getEditor

PropertyEditor getEditor()

This method can return null if there is no property editor registered for this type.

Returns:

getReferencedFields

String[] getReferencedFields(ReportElement element,
                             Object attributeValue)

getReferencedGroups

String[] getReferencedGroups(ReportElement element,
                             Object attributeValue)

getReferencedResources

ResourceReference[] getReferencedResources(ReportElement element,
                                           org.pentaho.reporting.libraries.resourceloader.ResourceManager resourceManager,
                                           Object attributeValue)

getExtraCalculationFields

String[] getExtraCalculationFields()