Class DerivedDataSetHandle

All Implemented Interfaces:
org.eclipse.birt.report.model.elements.interfaces.IDataSetModel, org.eclipse.birt.report.model.elements.interfaces.IDerivedDataSetModel, org.eclipse.birt.report.model.elements.interfaces.IDerivedExtendableElementModel, org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.ISimpleDataSetModel

public class DerivedDataSetHandle extends DataSetHandle implements org.eclipse.birt.report.model.elements.interfaces.IDerivedDataSetModel, org.eclipse.birt.report.model.elements.interfaces.IDerivedExtendableElementModel
Provides API to operate a derived data set.
  • Constructor Details

    • DerivedDataSetHandle

      public DerivedDataSetHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.elements.DerivedDataSet element)
      Constructs a handle of the joint data set with the given design and a joint data set. 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

    • setQueryText

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

      public String getQueryText()
      Returns the query text.
      Returns:
      the query text.
    • addInputDataSets

      public void addInputDataSets(String dataSetName) throws SemanticException
      Inserts a data set with the specified name into this derived data set.
      Parameters:
      dataSetName - name of the data set
      Throws:
      SemanticException
    • removeInputDataSet

      public void removeInputDataSet(String dataSetName) throws SemanticException
      Removes a data set with the specified name from this derived data set.
      Parameters:
      dataSetName - name of the data set to remove
      Throws:
      SemanticException
    • getInputDataSets

      public List<DataSetHandle> getInputDataSets()
      Gets the list of all the input data set handle that this derive data set includes. If no data set is included or no data set is found for input data set names, an empty list will be returned.
      Returns:
      list of the input data set handles
    • getExtensionID

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