Class ScriptDataSetHandle

  • 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.IScriptDataSetModel, org.eclipse.birt.report.model.elements.interfaces.ISimpleDataSetModel

    public class ScriptDataSetHandle
    extends DataSetHandle
    implements org.eclipse.birt.report.model.elements.interfaces.IScriptDataSetModel
    Represents a script data set item. The scripted data set gives the report developer the ability to implement a data set in code. The developer implements a series of simple scripts to open the data set, fetch each row, and to close the data set.
    See Also:
    ScriptDataSet
    • Constructor Detail

      • ScriptDataSetHandle

        public ScriptDataSetHandle​(org.eclipse.birt.report.model.core.Module module,
                                   org.eclipse.birt.report.model.core.DesignElement element)
        Constructs a handle for script data set.
        Parameters:
        module - the module
        element - the script data set element
    • Method Detail

      • getOpen

        public java.lang.String getOpen()
        Returns the script for opening data set.
        Returns:
        the script for opening data set.
      • setOpen

        public void setOpen​(java.lang.String value)
                     throws SemanticException
        Sets the script for opening data set.
        Parameters:
        value - the script to set
        Throws:
        SemanticException - if the property is locked.
      • getDescribe

        public java.lang.String getDescribe()
        Returns the script for describing the result set dynamically.
        Returns:
        the script for describing the result set dynamically
      • setDescribe

        public void setDescribe​(java.lang.String value)
                         throws SemanticException
        Sets the script for describing the result set dynamically.
        Parameters:
        value - the script to set
        Throws:
        SemanticException - if the property is locked.
      • getFetch

        public java.lang.String getFetch()
        Returns the script for providing the data for the next row from the result set. When the data set has returned the last row from the result set, subsequent calls to Fetch should return null. (Anull return value indicates the end of the result set.)
        Returns:
        the script for providing the data for the next row from the result set.
      • setFetch

        public void setFetch​(java.lang.String value)
                      throws SemanticException
        Sets the script for providing the data for the next row from the result set.
        Parameters:
        value - the script to set
        Throws:
        SemanticException - if the property is locked.
        See Also:
        getFetch()
      • getClose

        public java.lang.String getClose()
        Returns the script for closing data set.
        Returns:
        the script for closing data set.
      • setClose

        public void setClose​(java.lang.String value)
                      throws SemanticException
        Sets the script for closing data set.
        Parameters:
        value - the script to set
        Throws:
        SemanticException - if the property is locked.
      • resultSetIterator

        @Deprecated
        public java.util.Iterator resultSetIterator()
        Deprecated.
        by {#resultSetHintsIterator()}
        Returns an iterator over hints of the result set columns. The iterator returns instances of ResultSetColumnHandle that represents hints of result set column object.
        Overrides:
        resultSetIterator in class DataSetHandle
        Returns:
        iterator over hints of result set columns.
        See Also:
        DataSetHandle.resultSetIterator()
      • getPropertyHandle

        public PropertyHandle getPropertyHandle​(java.lang.String propName)
        Description copied from class: DesignElementHandle
        Returns a property handle for a top-level property. A top-level property is a property that defines on an element.
        Overrides:
        getPropertyHandle in class DataSetHandle
        Parameters:
        propName - the name of the property to get
        Returns:
        The property handle, or null if the no property exists with the given name.
        See Also:
        PropertyHandle