Class OdaDataSetHandle

  • All Implemented Interfaces:
    org.eclipse.birt.report.model.elements.interfaces.IDataSetModel, org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.IOdaDataSetModel, org.eclipse.birt.report.model.elements.interfaces.IOdaExtendableElementModel, org.eclipse.birt.report.model.elements.interfaces.ISimpleDataSetModel

    public class OdaDataSetHandle
    extends DataSetHandle
    implements org.eclipse.birt.report.model.elements.interfaces.IOdaDataSetModel, org.eclipse.birt.report.model.elements.interfaces.IOdaExtendableElementModel
    Represents an extended data set.
    See Also:
    OdaDataSet
    • Constructor Detail

      • OdaDataSetHandle

        public OdaDataSetHandle​(org.eclipse.birt.report.model.core.Module module,
                                org.eclipse.birt.report.model.core.DesignElement element)
        Constructs a handle for extended data set report item. The application generally does not create handles directly. Instead, it uses one of the navigation methods available on other element handles.
        Parameters:
        module - the module
        element - the model representation of the element
    • Method Detail

      • getPrivateDriverDesignState

        @Deprecated
        public java.lang.String getPrivateDriverDesignState()
        Deprecated.
        Returns the private driver design state.
        Returns:
        the private driver design state
      • getQueryScript

        @Deprecated
        public java.lang.String getQueryScript()
        Deprecated.
        to be removed.
        Returns the script for query.
        Returns:
        the script for query .
      • getQueryText

        public java.lang.String getQueryText()
        Returns the query text.
        Returns:
        the query text.
      • getType

        @Deprecated
        public java.lang.String getType()
        Deprecated.
        type has been replaced by extension ID
        Returns the data set type.
        Returns:
        the data set type
      • getResultSetName

        public java.lang.String getResultSetName()
        Returns the result set name.
        Returns:
        the result set name
      • setPrivateDriverDesignState

        @Deprecated
        public void setPrivateDriverDesignState​(java.lang.String state)
                                         throws SemanticException
        Deprecated.
        Sets the private driver design state.
        Parameters:
        state - the design state to set
        Throws:
        SemanticException - if this property is locked.
      • setQueryScript

        @Deprecated
        public void setQueryScript​(java.lang.String script)
                            throws SemanticException
        Deprecated.
        to be removed.
        Sets the query script.
        Parameters:
        script - the script to set
        Throws:
        SemanticException - if this property is locked.
      • setQueryText

        public void setQueryText​(java.lang.String text)
                          throws SemanticException
        Sets the query text.
        Parameters:
        text - the text to set
        Throws:
        SemanticException - if this property is locked.
      • setType

        @Deprecated
        public void setType​(java.lang.String type)
                     throws SemanticException
        Deprecated.
        type has been replaced by extension ID
        Sets the type.
        Parameters:
        type - the type to set
        Throws:
        SemanticException - if this property is locked.
      • setResultSetName

        public void setResultSetName​(java.lang.String name)
                              throws SemanticException
        Sets the result set name.
        Parameters:
        name - the name to set
        Throws:
        SemanticException - if this property is locked.
      • getExtensionName

        @Deprecated
        public java.lang.String getExtensionName()
        Deprecated.
        use getExtensionID()
        Returns the extension name defined by the extended item.
        Returns:
        the extension name as a string
      • getExtensionID

        public java.lang.String getExtensionID()
        Returns ID of the extension which extends this ODA data set.
        Returns:
        the extension ID
      • privateDriverPropertiesIterator

        public java.util.Iterator privateDriverPropertiesIterator()
        Returns the iterator for the private driver property list. The item over the iterator is the instance of ExtendedPropertyHandle.
        Returns:
        the iterator over private driver property list defined on this data set.
        See Also:
        ExtendedProperty
      • getPrivateDriverProperty

        public java.lang.String getPrivateDriverProperty​(java.lang.String name)
        Returns a private driver property value with the given property name.
        Parameters:
        name - the name of a public driver property
        Returns:
        a public driver property value
      • setPrivateDriverProperty

        public void setPrivateDriverProperty​(java.lang.String name,
                                             java.lang.String value)
                                      throws SemanticException
        Sets a private driver property value with the given name and value. If the property does not exist, it will be added into the property list. If the property already exists, the value of the property will be overwritten.
        Parameters:
        name - the name of a public driver property
        value - the value of a public driver property
        Throws:
        SemanticException - if name is null or an empty string after trimming.
      • getDefn

        public IElementDefn getDefn()
        Returns the element definition of the element this handle represents.
        Overrides:
        getDefn in class DesignElementHandle
        Returns:
        the element definition of the element this handle represents.
      • getExtensionPropertyDefinitionList

        public java.util.List getExtensionPropertyDefinitionList()
        Returns the list of extension property definition. All these properties are just those defined in extension plugin.
        Returns:
        the list of extension property definition.
      • getDesigerStateVersion

        public java.lang.String getDesigerStateVersion()
        Returns the version of designer state.
        Returns:
        the version of designer state.
      • setDesigerStateVersion

        public void setDesigerStateVersion​(java.lang.String version)
                                    throws SemanticException
        Returns the version of designer state.
        Parameters:
        version - the version of designer state.
        Throws:
        SemanticException - if designer state property is locked.
      • getDesigerStateContentAsString

        public java.lang.String getDesigerStateContentAsString()
        Returns the content of designer state as the string.
        Returns:
        the content of designer state as the string.
      • setDesigerStateContentAsString

        public void setDesigerStateContentAsString​(java.lang.String content)
                                            throws SemanticException
        Returns the content of designer state as the string.
        Parameters:
        content - the content of designer state as the string.
        Throws:
        SemanticException - if designer state property is locked.
      • getDesigerStateContentAsBlob

        public byte[] getDesigerStateContentAsBlob()
        Returns the content of designer state as the byte array.
        Returns:
        the content of designer state as the byte array.
      • setDesigerStateContentAsBlob

        public void setDesigerStateContentAsBlob​(byte[] content)
                                          throws SemanticException
        Returns the content of designer state as the byte.
        Parameters:
        content - the content of designer state as the byte.
        Throws:
        SemanticException - if designer state property is locked.
      • parametersIterator

        public java.util.Iterator parametersIterator()
        Returns an iterator over the list of oda dataset parameter definitions. The iterator returns instances of OdaDataSetParameterHandle that represents oda dataset parameter objects.
        Overrides:
        parametersIterator in class DataSetHandle
        Returns:
        iterator over oda dataset parameter definitions.
        See Also:
        DataSetParameter
      • getDesignerValues

        public java.lang.String getDesignerValues()
        Returns persistent ODA designer values stored in the data set.
        Returns:
        designer values in string
      • setDesignerValues

        public void setDesignerValues​(java.lang.String values)
                               throws SemanticException
        Stores persistent ODA designer values in the data set.
        Parameters:
        values - designer values in string
        Throws:
        SemanticException - if the property is locked.
      • getResultSetNumber

        public int getResultSetNumber()
        Gets the result set number.
        Returns:
        the result set number.
      • setResultSetNumber

        public void setResultSetNumber​(int number)
                                throws SemanticException
        Sets the result set number.
        Parameters:
        number - the result set number.
        Throws:
        SemanticException