Class DynamicFilterParameterHandle

All Implemented Interfaces:
org.eclipse.birt.report.model.elements.interfaces.IAbstractScalarParameterModel, org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.IDynamicFilterParameterModel, org.eclipse.birt.report.model.elements.interfaces.IInternalAbstractScalarParameterModel, org.eclipse.birt.report.model.elements.interfaces.IParameterModel

public class DynamicFilterParameterHandle extends AbstractScalarParameterHandle implements org.eclipse.birt.report.model.elements.interfaces.IDynamicFilterParameterModel
Represents the dynamic filter parameter types.
See Also:
  • DynamicFilterParameter
  • Constructor Details

    • DynamicFilterParameterHandle

      public DynamicFilterParameterHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
      Constructs a handle for the DynamicFilterParameter with the given design and the parameter.
      Parameters:
      module - the module
      element - the model representation of the element
  • Method Details

    • setDisplayType

      public void setDisplayType(String displayType) throws SemanticException
      Sets the display type for this parameter. The display type controls whether it is a simple filter or advanced filter. Types are defined in DesignChoiceConstants can be one of the followings:
      • DYNAMIC_FILTER_SIMPLE
      • DYNAMIC_FILTER_ADVANCED
      Parameters:
      displayType -
      Throws:
      SemanticException
    • getDisplayType

      public String getDisplayType()
      Gets the display type for this parameter. The display type controls whether it is a simple filter or advanced filter. Types are defined in DesignChoiceConstants can be one of the followings:
      • DYNAMIC_FILTER_SIMPLE
      • DYNAMIC_FILTER_ADVANCED
      Returns:
      the display value.
    • setColumn

      public void setColumn(String column) throws SemanticException
      Sets the column value.
      Parameters:
      column - the column value.
      Throws:
      SemanticException
    • getColumn

      public String getColumn()
      Gets the column value.
      Returns:
      the column value.
    • getFilterOperatorList

      public List<String> getFilterOperatorList()
      Returns the list containing filter operator.
      Returns:
      the list containing filter operator.
    • setFilterOperator

      public void setFilterOperator(List<String> filterOperatorList) throws SemanticException
      Sets the filter operator.
      Parameters:
      list - the filter operator list.
      Throws:
      SemanticException
    • getNativeDataType

      public int getNativeDataType()
      Gets the native data type of the dynamic parameter.
      Returns:
      the native data type of the dynamic parameter.
    • setNativeDataType

      public void setNativeDataType(int nativeDataType) throws SemanticException
      Sets the native data type of the dynamic parameter.
      Parameters:
      nativeDataType - the native data type to set
      Throws:
      SemanticException
    • getControlType

      public String getControlType()
      Returns the control type for this parameter. Control types are one of constants defined in DesignChoiceConstants:
      • PARAM_CONTROL_TEXT_BOX
      • PARAM_CONTROL_LIST_BOX
      Returns:
      the control type of the dynamic filter parameter.
    • setControlType

      public void setControlType(String controlType) throws SemanticException
      Sets the control type for this parameter. The value is defined in DesignChoiceConstants and can be one of:
      • PARAM_CONTROL_TEXT_BOX
      • PARAM_CONTROL_LIST_BOX
      Parameters:
      controlType - the control type value.
      Throws:
      SemanticException
    • checkRecursiveDataSet

      public boolean checkRecursiveDataSet(DataSetHandle dataSetToCheck)
      Checks whether there is recursive reference if this dynamic filter parameter uses the given data set element handle as its "dataSet" property. True if recursive reference exists; otherwise false if no recursive reference exists.
      Parameters:
      dataSetToCheck -
      Returns:
      true if recursive reference exists otherwise false