Class ExtendedProperty
java.lang.Object
org.eclipse.birt.report.model.core.Structure
org.eclipse.birt.report.model.api.elements.structures.ExtendedProperty
- All Implemented Interfaces:
Cloneable
,IStructure
,org.eclipse.birt.report.model.core.IPropertySet
public class ExtendedProperty
extends org.eclipse.birt.report.model.core.Structure
This class represents one Extended property.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.ExtendedProperty
(String name, String value) Constructs the extended property with the given name and value.ExtendedProperty
(String name, String value, String encryptionID) -
Method Summary
Modifier and TypeMethodDescriptionprotected Object
getIntrinsicProperty
(String propName) Returns the value of a structure property represented as a member variable.getName()
Returns the Extended property name.Returns the name of the structure definition.getValue()
Returns the Extended property value.handle
(SimpleValueHandle valueHandle, int index) Creates the specific handle of this structure.void
setEncryptionID
(String encryptionID) protected void
setIntrinsicProperty
(String propName, Object value) Sets the value of of a structure property represented as a member variable.void
Sets the Extended property name.void
Sets the Extended property value.validate
(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element) Validate whether this structure is valid.Methods inherited from class org.eclipse.birt.report.model.core.Structure
checkStringMember, copy, equals, getCompatibleValue, getContext, getDefn, getElement, getExpressionProperty, getHandle, getHandle, getLocalProperty, getLocalProperty, getMemberDefn, getObjectDefn, getProperty, getProperty, getReferencableProperty, getStringProperty, isDesignTime, isReferencable, setContext, setExpressionProperty, setProperty, setProperty, setupContext, updateReference
-
Field Details
-
Extended_PROPERTY_STRUCT
The Extended property structure name.- See Also:
-
NAME_MEMBER
The member name of the name of Extended property.- See Also:
-
VALUE_MEMBER
The member name of the value of Extended property.- See Also:
-
ENCRYPTION_ID_MEMBER
- See Also:
-
-
Constructor Details
-
ExtendedProperty
public ExtendedProperty()Default constructor. -
ExtendedProperty
Constructs the extended property with the given name and value.- Parameters:
name
- the name of a extended propertyvalue
- the value of a extended property
-
ExtendedProperty
-
-
Method Details
-
getStructName
Description copied from interface:IStructure
Returns the name of the structure definition. The name is the one used to define the structure in the meta-data dictionary.- Returns:
- the internal name of the structure a defined in the meta-data dictionary.
-
getIntrinsicProperty
Description copied from class:org.eclipse.birt.report.model.core.Structure
Returns the value of a structure property represented as a member variable.- Specified by:
getIntrinsicProperty
in classorg.eclipse.birt.report.model.core.Structure
- Parameters:
propName
- name of the property- Returns:
- the value of the property, or null if the property is not set
-
setIntrinsicProperty
Description copied from class:org.eclipse.birt.report.model.core.Structure
Sets the value of of a structure property represented as a member variable.- Specified by:
setIntrinsicProperty
in classorg.eclipse.birt.report.model.core.Structure
- Parameters:
propName
- the name of the property to setvalue
- the property value
-
getName
Returns the Extended property name.- Returns:
- the Extended property name
-
setName
Sets the Extended property name.- Parameters:
name
- the Extended property name to set
-
getValue
Returns the Extended property value.- Returns:
- the Extended property value
-
setValue
Sets the Extended property value.- Parameters:
value
- the Extended property value to set
-
getEncryptionID
-
setEncryptionID
-
validate
public List validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element) Description copied from class:org.eclipse.birt.report.model.core.Structure
Validate whether this structure is valid. The derived class should override this method if semantic check is needed. The each error is the instance ofPropertyValueException
.- Overrides:
validate
in classorg.eclipse.birt.report.model.core.Structure
- Parameters:
module
- the moduleelement
- the element contains this structure- Returns:
- the semantic error list
-
handle
Description copied from class:org.eclipse.birt.report.model.core.Structure
Creates the specific handle of this structure. This handle is always created.- Specified by:
handle
in classorg.eclipse.birt.report.model.core.Structure
- Parameters:
valueHandle
- the value handle of this structure list property this structure is inindex
- the position of this structure in structure list- Returns:
- the handle of this structure.
-