Class FilterConditionElementHandle

  • All Implemented Interfaces:
    org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.IFilterConditionElementModel

    public class FilterConditionElementHandle
    extends ContentElementHandle
    implements org.eclipse.birt.report.model.elements.interfaces.IFilterConditionElementModel
    • Constructor Detail

      • FilterConditionElementHandle

        public FilterConditionElementHandle​(org.eclipse.birt.report.model.core.Module module,
                                            org.eclipse.birt.report.model.core.DesignElement element)
        Constructs a filter condition 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 Detail

      • getExpr

        public java.lang.String getExpr()
        Returns the filter expression.
        Returns:
        the filter expression
      • setExpr

        public void setExpr​(java.lang.String filterExpr)
                     throws SemanticException
        Sets the filter expression.
        Parameters:
        filterExpr - the filter expression to set
        Throws:
        SemanticException - value required exception
      • getOperator

        public java.lang.String getOperator()
        Returns the operator of this filter condition. The possible values are defined in DesignChoiceConstants, and they are:
        • FILTER_OPERATOR_EQ
        • FILTER_OPERATOR_NE
        • FILTER_OPERATOR_LT
        • FILTER_OPERATOR_LE
        • FILTER_OPERATOR_GE
        • FILTER_OPERATOR_GT
        • FILTER_OPERATOR_BETWEEN
        • FILTER_OPERATOR_NOT_BETWEEN
        • FILTER_OPERATOR_NULL
        • FILTER_OPERATOR_NOT_NULL
        • FILTER_OPERATOR_TRUE
        • FILTER_OPERATOR_FALSE
        • FILTER_OPERATOR_LIKE
        • FILTER_OPERATOR_TOP_N
        • FILTER_OPERATOR_BOTTOM_N
        • FILTER_OPERATOR_TOP_PERCENT
        • FILTER_OPERATOR_BOTTOM_PERCENT
        • FILTER_OPERATOR_ANY
        Returns:
        the operator of this filter condition
      • setOperator

        public void setOperator​(java.lang.String operator)
                         throws SemanticException
        Sets the operator of this filter condition. The allowed values are defined in DesignChoiceConstants, and they are:
        • FILTER_OPERATOR_EQ
        • FILTER_OPERATOR_NE
        • FILTER_OPERATOR_LT
        • FILTER_OPERATOR_LE
        • FILTER_OPERATOR_GE
        • FILTER_OPERATOR_GT
        • FILTER_OPERATOR_BETWEEN
        • FILTER_OPERATOR_NOT_BETWEEN
        • FILTER_OPERATOR_NULL
        • FILTER_OPERATOR_NOT_NULL
        • FILTER_OPERATOR_TRUE
        • FILTER_OPERATOR_FALSE
        • FILTER_OPERATOR_LIKE
        • FILTER_OPERATOR_TOP_N
        • FILTER_OPERATOR_BOTTOM_N
        • FILTER_OPERATOR_TOP_PERCENT
        • FILTER_OPERATOR_BOTTOM_PERCENT
        • FILTER_OPERATOR_ANY
        Parameters:
        operator - the operator to set
        Throws:
        SemanticException - if operator is not in the choice list.
      • getValue1

        public java.lang.String getValue1()
        Returns the value 1 expression of this filter condition.
        Returns:
        the value 1 expression of this filter condition
      • getValue1List

        @Deprecated
        public java.util.List getValue1List()
        Gets the value1 expression list of this filter condition. For most filter operator, there is only one expression in the returned list. However, filter operator 'in' may contain more than one expression.
        Returns:
        the value1 expression list of this filter condition.
      • getValue1ExpressionList

        public ExpressionListHandle getValue1ExpressionList()
        Gets the value1 expression list of this filter condition. For most filter operator, there is only one expression in the returned list. However, filter operator 'in' may contain more than one expression.
        Returns:
        the value1 expression list of this filter condition.
      • setValue1

        public void setValue1​(java.lang.String value1Expr)
                       throws SemanticException
        Sets the value 1 expression of this filter condition.
        Parameters:
        value1Expr - the value 1 expression to set
        Throws:
        SemanticException
      • setValue1

        public void setValue1​(java.util.List value1List)
                       throws SemanticException
        Sets the value 1 expression list of this filter condition.
        Parameters:
        value1List - the value 1 expression list to set
        Throws:
        SemanticException - if the instance in the list is not valid
      • getValue2

        public java.lang.String getValue2()
        Returns the value 2 expression of this filter condition.
        Returns:
        the value 2 expression of this filter condition
      • setValue2

        public void setValue2​(java.lang.String value2Expr)
                       throws SemanticException
        Sets the value 2 expression of this filter condition.
        Parameters:
        value2Expr - the value 2 expression to set
        Throws:
        SemanticException
      • getFilterTarget

        public java.lang.String getFilterTarget()
        Returns the filter target. The possible values are defined in DesignChoiceConstants, and they are:
        • FILTER_TARGET_DATA_SET
        • FILTER_TARGET_RESULT_SET
        Returns:
        the target type
      • setFilterTarget

        public void setFilterTarget​(java.lang.String filterTarget)
                             throws SemanticException
        Sets the filter target. The allowed values are defined in DesignChoiceConstants, and they are:
        • FILTER_TARGET_DATA_SET
        • FILTER_TARGET_RESULT_SET
        Parameters:
        filterTarget - the filter target to set
        Throws:
        SemanticException - if the value is not one of the above.
      • getMember

        public MemberValueHandle getMember()
        Gets the member value handle of this filter condition element if it sets. Otherwise return null.
        Returns:
      • isOptional

        public boolean isOptional()
        Determines whether this filter condition is optional or not.
        Returns:
        true if this filter is optional, otherwise false
      • setOptional

        public void setOptional​(boolean isOptional)
                         throws SemanticException
        Sets the optional status for this filter condition.
        Parameters:
        isOptional - true if this filter is optional, otherwise false
        Throws:
        SemanticException
      • getExtensionName

        public java.lang.String getExtensionName()
        Returns the unique id of an org.eclipse.datatools.connectivity.oda.filterExpressions extension to whose custom expressions are defined to map to a BIRT filter operator.
        Returns:
        the extension name
      • getExtensionExprId

        public java.lang.String getExtensionExprId()
        Returns the id of a custom filter expression contributed and defined by the extension identified in the consumerExpressionMapping.
        Returns:
        the extension expression id
      • pushDown

        public boolean pushDown()
        Indicate if the current filter condition will be pushed down to the database. Default value is false. Only the oda extension provider supported operators can be pushed down to database. For those only BIRT supported operators even this property is set to true, will be ignored.
        Returns:
        true if the current filter condition will be pushed down to the database, otherwise false.
      • getDynamicFilterParameter

        public java.lang.String getDynamicFilterParameter()
        Returns the name of the dynamic filter parameter to reference when the filter condition is dynamic.
        Returns:
        the name to the dynamic filter parameter to reference.
      • setExtensionName

        public void setExtensionName​(java.lang.String extensionName)
                              throws SemanticException
        Sets the unique id of an org.eclipse.datatools.connectivity.oda.filterExpressions extension to whose custom expressions are defined to map to a BIRT filter operator.
        Parameters:
        extensionName - the extension name to set
        Throws:
        SemanticException
      • setExtensionExprId

        public void setExtensionExprId​(java.lang.String extensionExprId)
                                throws SemanticException
        Sets the id of a custom filter expression contributed and defined by the extension identified in the consumerExpressionMapping.
        Parameters:
        extensionExprId - the id to set
        Throws:
        SemanticException
      • setPushDown

        public void setPushDown​(boolean pushDown)
                         throws SemanticException
        Sets the push down status for this filter condition
        Parameters:
        pushDown - true if the current filter condition will be pushed down to the database, otherwise false.
        Throws:
        SemanticException
      • setDynamicFilterParameter

        public void setDynamicFilterParameter​(java.lang.String parameterName)
                                       throws SemanticException
        Sets the name of the dynamic filter parameter to reference.
        Parameters:
        parameterName - the name of the dynamic filter parameter to set
        Throws:
        SemanticException
      • getType

        public java.lang.String getType()
        Returns the type of this filter condition. The possible values are defined in DesignChoiceConstants, and they are:
        • FILTER_CONDITION_TYPE_SLICER
        • FILTER_CONDITION_TYPE_SIMPLE
        Returns:
        the operator of this filter condition
      • setType

        public void setType​(java.lang.String type)
                     throws SemanticException
        Sets the type of this filter condition. The allowed values are defined in DesignChoiceConstants, and they are:
        • FILTER_CONDITION_TYPE_SLICER
        • FILTER_CONDITION_TYPE_SIMPLE
        Parameters:
        type - the type to set
        Throws:
        SemanticException - if type is not in the choice list.
      • updateAggregation

        public boolean updateAggregation()
        Checks if this filter condition needs to update aggregation.
        Returns:
        the flag to indicate updating aggregation or not.
      • setUpdateAggregation

        public void setUpdateAggregation​(boolean updateAggregation)
                                  throws SemanticException
        Sets the updateAggregation flag of the filter condition.
        Parameters:
        updateAggregation - the updateAggregation flag to set
        Throws:
        SemanticException