org.eclipse.birt.report.model.api.metadata
Interface IPropertyDefn

All Known Subinterfaces:

IElementPropertyDefn

All Known Implementing Classes:

org.eclipse.birt.report.model.metadata.ElementPropertyDefn, org.eclipse.birt.report.model.metadata.PropertyDefn

public interface IPropertyDefn

Base Interface for both element property, extension model property and structure member definitions.

Field Summary

static int	EXTENSION_MODEL_PROPERTY Type code for a property defined by an extension implementation of ReportItemExtensionPoint.
static int	EXTENSION_PROPERTY Type code for a property defined in XML file with the ReportItemExtensionPoint.
static int	ODA_PROPERTY Type code for a property defined by a ODA extension.
static int	SYSTEM_PROPERTY Type code for a system property.
static int	USER_PROPERTY Type code for a user property.

Method Summary

IChoiceSet	getAllowedChoices() Returns the allowed choices for this property.
IChoiceSet	getChoices() Gets the list of choices for the property.
java.lang.Object	getDefault() Returns the default value for the property.
java.lang.String	getDisplayName() Returns the display name for the property.
java.lang.String	getDisplayNameID() Returns the message id for the display name.
java.lang.String	getName() Returns the internal name for the property.
IStructureDefn	getStructDefn() Returns the structure definition for this value.
IElementDefn	getTargetElementType() Return the element type associated with this property.
int	getTypeCode() Returns the property type.
int	getValueType() Returns the type of this value.
boolean	hasChoices() Checks if a property has a set of choices whatever choice is choice, extended choice or user defined choice.
boolean	isEncryptable() Returns whether this property should be encrypted.
boolean	isList() Indicates whether this property is a list.

Field Detail

SYSTEM_PROPERTY

public static final int SYSTEM_PROPERTY

Type code for a system property.

See Also:

Constant Field Values

USER_PROPERTY

public static final int USER_PROPERTY

Type code for a user property.

See Also:

Constant Field Values

EXTENSION_PROPERTY

public static final int EXTENSION_PROPERTY

Type code for a property defined in XML file with the ReportItemExtensionPoint.

See Also:

Constant Field Values

EXTENSION_MODEL_PROPERTY

public static final int EXTENSION_MODEL_PROPERTY

Type code for a property defined by an extension implementation of ReportItemExtensionPoint.

See Also:

Constant Field Values

ODA_PROPERTY

public static final int ODA_PROPERTY

Type code for a property defined by a ODA extension.

See Also:

Constant Field Values

Method Detail

isList

public boolean isList()

Indicates whether this property is a list. It is useful only when the property type is a structure type.

Returns:

whether the property is a list or not.

getName

public java.lang.String getName()

Returns the internal name for the property.

Returns:

the internal (non-localized) name for the property

getTypeCode

public int getTypeCode()

Returns the property type. See the list in PropertyType.

Returns:

he property type code

getDisplayName

public java.lang.String getDisplayName()

Returns the display name for the property.

Returns:

the user-visible, localized display name for the property

getDisplayNameID

public java.lang.String getDisplayNameID()

Returns the message id for the display name.

Returns:

The display name message ID.

getChoices

public IChoiceSet getChoices()

Gets the list of choices for the property.

Returns:

the list of choices

hasChoices

public boolean hasChoices()

Checks if a property has a set of choices whatever choice is choice, extended choice or user defined choice.

Returns:

true if it has, otherwise false.

getStructDefn

public IStructureDefn getStructDefn()

Returns the structure definition for this value.

Returns:

the structure definition, or null if this value is not a list of structures

getDefault

public java.lang.Object getDefault()

Returns the default value for the property.

Returns:

The default value.

getTargetElementType

public IElementDefn getTargetElementType()

Return the element type associated with this property.

Returns:

the element type associated with the property

getAllowedChoices

public IChoiceSet getAllowedChoices()

Returns the allowed choices for this property. It contains allowed choices for a choice type, or containing an allowed units set for a dimension type.

If a property has not defined the restriction, then whole set will be returned.

Returns:

Returns the allowed choices of this property.

isEncryptable

public boolean isEncryptable()

Returns whether this property should be encrypted.

Returns:

true if this property should be encrypted.

getValueType

public int getValueType()

Returns the type of this value. The return can be one of the following constants:

• SYSTEM_PROPERTY
• USER_PROPERTY
• STRUCT_PROPERTY
• EXTENSION_PROPERTY

Returns:

the type of this definition