org.pentaho.reporting.engine.classic.core.metadata
Class DefaultAttributeMetaData
java.lang.Object
org.pentaho.reporting.engine.classic.core.metadata.AbstractMetaData
org.pentaho.reporting.engine.classic.core.metadata.DefaultAttributeMetaData
- All Implemented Interfaces:
- Serializable, AttributeMetaData, MetaData
public class DefaultAttributeMetaData
- extends AbstractMetaData
- implements AttributeMetaData
- See Also:
- Serialized Form
Fields inherited from interface org.pentaho.reporting.engine.classic.core.metadata.AttributeMetaData |
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 |
Constructor Summary |
DefaultAttributeMetaData(String namespace,
String name,
String bundleLocation,
String keyPrefix,
String propertyEditorClass,
Class targetClass,
boolean expert,
boolean preferred,
boolean hidden,
boolean deprecated,
boolean mandatory,
boolean computed,
boolean transientFlag,
String valueRole,
boolean bulk,
boolean designTimeValue,
AttributeCore attributeCore,
boolean experimental,
int compatibilityLevel)
|
Method Summary |
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", |
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. |
String |
toString()
|
Methods inherited from class org.pentaho.reporting.engine.classic.core.metadata.AbstractMetaData |
getBundle, getBundleLocation, getCompatibilityLevel, getDeprecationMessage, getDescription, getDisplayName, getGrouping, getGroupingOrdinal, getIcon, getItemOrdinal, getKeyPrefix, getMetaAttribute, getName, isDeprecated, isExperimental, isExpert, isHidden, isPreferred |
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 |
DefaultAttributeMetaData
public DefaultAttributeMetaData(String namespace,
String name,
String bundleLocation,
String keyPrefix,
String propertyEditorClass,
Class targetClass,
boolean expert,
boolean preferred,
boolean hidden,
boolean deprecated,
boolean mandatory,
boolean computed,
boolean transientFlag,
String valueRole,
boolean bulk,
boolean designTimeValue,
AttributeCore attributeCore,
boolean experimental,
int compatibilityLevel)
getValueRole
public String getValueRole()
- Can be one of "Value", "Resource", "Content", "Field", "Group", "Query", "Message", "Bundle-Key", "Bundle-Name",
"Name", "ElementName",
- Specified by:
getValueRole
in interface AttributeMetaData
- Returns:
isDesignTimeValue
public boolean isDesignTimeValue()
- Description copied from interface:
AttributeMetaData
- 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.
- Specified by:
isDesignTimeValue
in interface AttributeMetaData
- Returns:
isBulk
public boolean isBulk()
- Specified by:
isBulk
in interface AttributeMetaData
isComputed
public boolean isComputed()
- Description copied from interface:
AttributeMetaData
- 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.
- Specified by:
isComputed
in interface AttributeMetaData
isTransient
public boolean isTransient()
- Description copied from interface:
AttributeMetaData
- 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.
- Specified by:
isTransient
in interface AttributeMetaData
isMandatory
public boolean isMandatory()
- Specified by:
isMandatory
in interface AttributeMetaData
getNameSpace
public String getNameSpace()
- Specified by:
getNameSpace
in interface AttributeMetaData
getTargetType
public Class getTargetType()
- Specified by:
getTargetType
in interface AttributeMetaData
getEditor
public PropertyEditor getEditor()
- Description copied from interface:
AttributeMetaData
- This method can return null if there is no property editor registered for this type.
- Specified by:
getEditor
in interface AttributeMetaData
- Returns:
getReferencedFields
public String[] getReferencedFields(ReportElement element,
Object attributeValue)
- Specified by:
getReferencedFields
in interface AttributeMetaData
getReferencedGroups
public String[] getReferencedGroups(ReportElement element,
Object attributeValue)
- Specified by:
getReferencedGroups
in interface AttributeMetaData
getReferencedResources
public ResourceReference[] getReferencedResources(ReportElement element,
org.pentaho.reporting.libraries.resourceloader.ResourceManager resourceManager,
Object attributeValue)
- Specified by:
getReferencedResources
in interface AttributeMetaData
toString
public String toString()
- Overrides:
toString
in class Object
getExtraCalculationFields
public String[] getExtraCalculationFields()
- Specified by:
getExtraCalculationFields
in interface AttributeMetaData