Interface IFilterConditionElement
-
- All Superinterfaces:
IDesignElement
public interface IFilterConditionElement extends IDesignElement
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetExpr()Returns the filter expression.java.lang.StringgetFilterTarget()Returns the filter target.java.lang.StringgetOperator()Returns the operator of this filter condition.java.util.ListgetValue1List()Gets the value1 expression list of this filter condition.java.lang.StringgetValue2()Returns the value 2 expression of this filter condition.booleanisOptional()Determines whether this filter condition is optional or not.voidsetExpr(java.lang.String filterExpr)Sets the filter expression.voidsetFilterTarget(java.lang.String filterTarget)Sets the filter target.voidsetOperator(java.lang.String operator)Sets the operator of this filter condition.voidsetOptional(boolean isOptional)Sets the optional status for this filter condition.voidsetValue1(java.util.List value1List)Sets the value 1 expression list of this filter condition.voidsetValue2(java.lang.String value2Expr)Sets the value 2 expression of this filter condition.-
Methods inherited from interface org.eclipse.birt.report.model.api.simpleapi.IDesignElement
getNamedExpression, getParent, getQualifiedName, getReport, getStyle, getUserProperty, getUserPropertyExpression, setNamedExpression, setUserProperty, setUserProperty
-
-
-
-
Method Detail
-
getExpr
java.lang.String getExpr()
Returns the filter expression.- Returns:
- the filter expression
-
setExpr
void setExpr(java.lang.String filterExpr) throws SemanticExceptionSets the filter expression.- Parameters:
filterExpr- the filter expression to set- Throws:
SemanticException- value required exception
-
getOperator
java.lang.String getOperator()
Returns the operator of this filter condition. The possible values are defined inDesignChoiceConstants, and they are:FILTER_OPERATOR_EQFILTER_OPERATOR_NEFILTER_OPERATOR_LTFILTER_OPERATOR_LEFILTER_OPERATOR_GEFILTER_OPERATOR_GTFILTER_OPERATOR_BETWEENFILTER_OPERATOR_NOT_BETWEENFILTER_OPERATOR_NULLFILTER_OPERATOR_NOT_NULLFILTER_OPERATOR_TRUEFILTER_OPERATOR_FALSEFILTER_OPERATOR_LIKEFILTER_OPERATOR_TOP_NFILTER_OPERATOR_BOTTOM_NFILTER_OPERATOR_TOP_PERCENTFILTER_OPERATOR_BOTTOM_PERCENTFILTER_OPERATOR_ANY
- Returns:
- the operator of this filter condition
-
setOperator
void setOperator(java.lang.String operator) throws SemanticExceptionSets the operator of this filter condition. The allowed values are defined inDesignChoiceConstants, and they are:FILTER_OPERATOR_EQFILTER_OPERATOR_NEFILTER_OPERATOR_LTFILTER_OPERATOR_LEFILTER_OPERATOR_GEFILTER_OPERATOR_GTFILTER_OPERATOR_BETWEENFILTER_OPERATOR_NOT_BETWEENFILTER_OPERATOR_NULLFILTER_OPERATOR_NOT_NULLFILTER_OPERATOR_TRUEFILTER_OPERATOR_FALSEFILTER_OPERATOR_LIKEFILTER_OPERATOR_TOP_NFILTER_OPERATOR_BOTTOM_NFILTER_OPERATOR_TOP_PERCENTFILTER_OPERATOR_BOTTOM_PERCENTFILTER_OPERATOR_ANY
- Parameters:
operator- the operator to set- Throws:
SemanticException- if operator is not in the choice list.
-
getValue1List
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.
-
setValue1
void setValue1(java.util.List value1List) throws SemanticExceptionSets 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
java.lang.String getValue2()
Returns the value 2 expression of this filter condition.- Returns:
- the value 2 expression of this filter condition
-
setValue2
void setValue2(java.lang.String value2Expr) throws SemanticExceptionSets the value 2 expression of this filter condition.- Parameters:
value2Expr- the value 2 expression to set- Throws:
SemanticException
-
getFilterTarget
java.lang.String getFilterTarget()
Returns the filter target. The possible values are defined inDesignChoiceConstants, and they are:FILTER_TARGET_DATA_SETFILTER_TARGET_RESULT_SET
- Returns:
- the target type
-
setFilterTarget
void setFilterTarget(java.lang.String filterTarget) throws SemanticExceptionSets the filter target. The allowed values are defined inDesignChoiceConstants, and they are:FILTER_TARGET_DATA_SETFILTER_TARGET_RESULT_SET
- Parameters:
filterTarget- the filter target to set- Throws:
SemanticException- if the value is not one of the above.
-
isOptional
boolean isOptional()
Determines whether this filter condition is optional or not.- Returns:
- true if this filter is optional, otherwise false
-
setOptional
void setOptional(boolean isOptional) throws SemanticExceptionSets the optional status for this filter condition.- Parameters:
isOptional- true if this filter is optional, otherwise false- Throws:
SemanticException
-
-