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 Details

  • Constructor Details

    • ExtendedProperty

      public ExtendedProperty()
      Default constructor.
    • ExtendedProperty

      public ExtendedProperty(String name, String value)
      Constructs the extended property with the given name and value.
      Parameters:
      name - the name of a extended property
      value - the value of a extended property
    • ExtendedProperty

      public ExtendedProperty(String name, String value, String encryptionID)
  • Method Details

    • getStructName

      public String 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

      protected Object getIntrinsicProperty(String propName)
      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 class org.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

      protected void setIntrinsicProperty(String propName, Object value)
      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 class org.eclipse.birt.report.model.core.Structure
      Parameters:
      propName - the name of the property to set
      value - the property value
    • getName

      public String getName()
      Returns the Extended property name.
      Returns:
      the Extended property name
    • setName

      public void setName(String name)
      Sets the Extended property name.
      Parameters:
      name - the Extended property name to set
    • getValue

      public String getValue()
      Returns the Extended property value.
      Returns:
      the Extended property value
    • setValue

      public void setValue(String value)
      Sets the Extended property value.
      Parameters:
      value - the Extended property value to set
    • getEncryptionID

      public String getEncryptionID()
    • setEncryptionID

      public void setEncryptionID(String encryptionID)
    • 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 of PropertyValueException.
      Overrides:
      validate in class org.eclipse.birt.report.model.core.Structure
      Parameters:
      module - the module
      element - the element contains this structure
      Returns:
      the semantic error list
    • handle

      public StructureHandle handle(SimpleValueHandle valueHandle, int index)
      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 class org.eclipse.birt.report.model.core.Structure
      Parameters:
      valueHandle - the value handle of this structure list property this structure is in
      index - the position of this structure in structure list
      Returns:
      the handle of this structure.