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 Details

    • 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 Details

    • getExtensionName

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

      public String getExtensionID()
      Returns ID of the extension which extends this ODA data source.
      Returns:
      the extension ID
    • setDriverName

      @Deprecated public void setDriverName(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 String getDriverName()
      Deprecated.
      This property is removed.
      Returns the driver name.
      Returns:
      the driver name
    • privateDriverPropertiesIterator

      public 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:
    • getPrivateDriverProperty

      public String getPrivateDriverProperty(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(String name, 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 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 String getDesigerStateVersion()
      Returns the version of designer state.
      Returns:
      the version of designer state.
    • setDesigerStateVersion

      public void setDesigerStateVersion(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 String getDesigerStateContentAsString()
      Returns the content of designer state as the string.
      Returns:
      the content of designer state as the string.
    • setDesigerStateContentAsString

      public void setDesigerStateContentAsString(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.
    • getDesignerState

      public OdaDesignerStateHandle getDesignerState()
      Returns the oda designer state.
      Returns:
      a handle to the designer state property, return null if the designer state.
      See Also:
    • setDesignerState

      public OdaDesignerStateHandle setDesignerState(OdaDesignerState designerState) throws SemanticException
      Sets the designer state for a oda data source.
      Parameters:
      designerState - new designer state
      Returns:
      a handle to the designer state
      Throws:
      SemanticException - if member of the designer state is not valid.
    • getExternalConnectionName

      public String getExternalConnectionName()
    • setExternalConnectionName

      public void setExternalConnectionName(String externalConnectionName) throws SemanticException
      Throws:
      SemanticException