Class OdaDataSourceHandle

  • All Implemented Interfaces:
    org.eclipse.birt.report.model.elements.interfaces.IDataSourceModel, org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.IOdaDataSourceModel, org.eclipse.birt.report.model.elements.interfaces.IOdaExtendableElementModel

    public class OdaDataSourceHandle
    extends DataSourceHandle
    implements org.eclipse.birt.report.model.elements.interfaces.IOdaDataSourceModel, org.eclipse.birt.report.model.elements.interfaces.IOdaExtendableElementModel
    Represents a extended data source.
    See Also:
    OdaDataSource
    • Constructor Detail

      • OdaDataSourceHandle

        public OdaDataSourceHandle​(org.eclipse.birt.report.model.core.Module module,
                                   org.eclipse.birt.report.model.core.DesignElement element)
        Constructs an extended data source handle with the given design and the element. 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

      • getExtensionName

        @Deprecated
        public java.lang.String getExtensionName()
        Deprecated.
        use getExtensioID()
        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 source.
        Returns:
        the extension ID
      • setDriverName

        @Deprecated
        public void setDriverName​(java.lang.String driverName)
                           throws SemanticException
        Deprecated.
        This property is removed.
        Sets the driver name.
        Parameters:
        driverName - the name to set
        Throws:
        SemanticException - if this property is locked.
      • getDriverName

        @Deprecated
        public java.lang.String getDriverName()
        Deprecated.
        This property is removed.
        Returns the driver name.
        Returns:
        the driver name
      • 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 source.
        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 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.
      • getExternalConnectionName

        public java.lang.String getExternalConnectionName()