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

Interface ElementMetaData

All Superinterfaces:

MetaData

All Known Implementing Classes:

DefaultElementMetaData

public interface ElementMetaData
extends MetaData

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ElementMetaData.TypeClassification

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
ElementType	create()
AttributeMetaData	getAttributeDescription(String namespace, String name)
AttributeMetaData[]	getAttributeDescriptions()
Class<?>	getContentType()
Class<? extends ElementType>	getElementType()
Image	getIcon(Locale locale, int iconKind)
String	getNamespace()	The namespace of the elemnet in an PRPT bundle.
ElementMetaData.TypeClassification	getReportElementType()
StyleMetaData	getStyleDescription(StyleKey name)
StyleMetaData[]	getStyleDescriptions()
boolean	isContainerElement()	Indicates whether the element described here is a container element, like "band".

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

getIcon

Image getIcon(Locale locale,
              int iconKind)

Parameters:

locale - the locale.

iconKind - one of java.beans.BeanInfo#ICON_COLOR_16x16, java.beans.BeanInfo#ICON_COLOR_32x32, java.beans.BeanInfo#ICON_MONO_16x16, or java.beans.BeanInfo#ICON_MONO_32x32

Returns:

the image or null, if there is no icon.

See Also:

for the general semantics

getAttributeDescriptions

AttributeMetaData[] getAttributeDescriptions()

getStyleDescriptions

StyleMetaData[] getStyleDescriptions()

getAttributeDescription

AttributeMetaData getAttributeDescription(String namespace,
                                          String name)

getStyleDescription

StyleMetaData getStyleDescription(StyleKey name)

create

ElementType create()
            throws InstantiationException

Throws:

InstantiationException

isContainerElement

boolean isContainerElement()

Indicates whether the element described here is a container element, like "band". Such element-types are tied to a specific element instance and cannot be shared freely.

Returns:

getContentType

Class<?> getContentType()

getElementType

Class<? extends ElementType> getElementType()

getReportElementType

ElementMetaData.TypeClassification getReportElementType()

getNamespace

String getNamespace()

The namespace of the elemnet in an PRPT bundle.

Returns: