Class JointDataSetHandle

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

    public class JointDataSetHandle
    extends DataSetHandle
    implements org.eclipse.birt.report.model.elements.interfaces.IJointDataSetModel
    Provides API to operate a joint data set.
    See Also:
    JointDataSet
    • Constructor Detail

      • JointDataSetHandle

        public JointDataSetHandle​(org.eclipse.birt.report.model.core.Module module,
                                  org.eclipse.birt.report.model.elements.JointDataSet 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 Detail

      • getDataSetNames

        public java.util.List getDataSetNames()
        Gets the names of the data sets in this joint data set.
        Returns:
        a list of names of data sets in this joint data set.
      • dataSetsIterator

        public java.util.Iterator dataSetsIterator()
        Gets data sets in this joint data set. Each item in the list is instance of DataSetHandle.
        Returns:
        a list of data sets in this joint data set.
      • addDataSet

        public void addDataSet​(java.lang.String dataSetName)
                        throws SemanticException
        Adds a data set into this joint data set by name.
        Parameters:
        dataSetName - the name of the data set to be added in.
        Throws:
        SemanticException - if the the value of the item is incorrect.
      • removeDataSet

        public void removeDataSet​(java.lang.String dataSetName)
                           throws SemanticException
        Removes a data set from this joint data set by name.
        Parameters:
        dataSetName - the name of the data set to be removed.
        Throws:
        SemanticException - if the the value of the item is incorrect.
      • joinConditionsIterator

        public java.util.Iterator joinConditionsIterator()
        Returns the iterator of join conditions. The element in the iterator is the corresponding JoinConditionHandle that deal with a JoinCondition.
        Returns:
        the iterator of join condition structure list
      • paramBindingsIterator

        public java.util.Iterator paramBindingsIterator()
        Description copied from class: DataSetHandle
        Returns an iterator over the list of parameter bindings. The iterator returns instances of ParamBindingHandle that represents parameter binding object.
        Overrides:
        paramBindingsIterator in class DataSetHandle
        Returns:
        iterator over parameter binding.
        See Also:
        ParamBinding
      • setProperty

        public void setProperty​(java.lang.String propName,
                                java.lang.Object value)
                         throws SemanticException
        Description copied from class: DesignElementHandle
        Sets the value of a property from a generic object. The value can be any of the supported types: String, Double, Integer, BigDecimal or one of the specialized property types. The type of object allowed depends on the type of the property.
        Overrides:
        setProperty in class DesignElementHandle
        Parameters:
        propName - the property name
        value - the value to set
        Throws:
        SemanticException - if the property is undefined on the element or the value is invalid.