Interface IStructure

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      IStructure copy()
      Creates a deep copy of this structure.
      IStructureDefn getDefn()
      Returns the structure definition from the meta-data dictionary.
      java.lang.Object getLocalProperty​(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.metadata.PropertyDefn propDefn)
      java.lang.Object getProperty​(org.eclipse.birt.report.model.core.Module module, java.lang.String propName)
      Gets the locale value of a property.
      java.lang.String getStructName()
      Returns the name of the structure definition.
      boolean isDesignTime()
      Justifies whether the structure is generated in design time or not.
      boolean isReferencable()
      Justifies whether the structure can be referred by other design elements.
      • Methods inherited from interface org.eclipse.birt.report.model.core.IPropertySet

        getObjectDefn, getProperty, setProperty
    • Method Detail

      • getStructName

        java.lang.String getStructName()
        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.
      • copy

        IStructure copy()
        Creates a deep copy of this structure.
        Returns:
        a copy of this structure.
      • getDefn

        IStructureDefn getDefn()
        Returns the structure definition from the meta-data dictionary.
        Returns:
        the structure definition
      • getLocalProperty

        @Deprecated
        java.lang.Object getLocalProperty​(org.eclipse.birt.report.model.core.Module module,
                                          org.eclipse.birt.report.model.metadata.PropertyDefn propDefn)
        Gets the locale value of a property.
        Parameters:
        module - the module
        propDefn - definition of the property to get
        Returns:
        value of the item as an object, or null if the item is not set locally or is not found.
      • getProperty

        java.lang.Object getProperty​(org.eclipse.birt.report.model.core.Module module,
                                     java.lang.String propName)
        Gets the locale value of a property.
        Parameters:
        module - the module
        propName - the name of the property definition
        Returns:
        value of the item as an object, or null if the item is not set locally or is not found.
      • isReferencable

        boolean isReferencable()
        Justifies whether the structure can be referred by other design elements.
        Returns:
        true if the structure is referencable, otherwise false
      • isDesignTime

        boolean isDesignTime()
        Justifies whether the structure is generated in design time or not.
        Returns:
        if the structure is generated in design time, otherwise return .