public class FilterConditionHandle extends StructureHandle
This is a managed object, meaning that all changes should be made though the command layer so that they can be undone and redone. Each filter condition has the following properties:
structContext
elementHandle
Constructor and Description |
---|
FilterConditionHandle(SimpleValueHandle valueHandle,
int index)
Constructs the handle of filter condition.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getColumn()
Deprecated.
This property has been removed.
|
java.lang.String |
getCustomValue()
Returns the user specified value.
|
java.lang.String |
getDynamicFilterParameter()
Returns the name of the dynamic filter parameter to reference when the
filter condition is dynamic.
|
java.lang.String |
getExpr()
Returns the filter expression.
|
java.lang.String |
getExtensionExprId()
Returns the id of a custom filter expression contributed and defined by
the extension identified in the consumerExpressionMapping.
|
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.
|
java.lang.String |
getFilterExpr()
Deprecated.
Replaced by the method
getExpr() |
java.lang.String |
getFilterTarget()
Returns the filter target.
|
java.lang.String |
getOperator()
Returns the operator of this filter condition.
|
java.lang.String |
getType()
Returns the type of this filter condition.
|
java.lang.String |
getValue1()
Returns the value 1 expression of this filter condition.
|
java.lang.String |
getValue1Expr()
Deprecated.
Replaced by the method
getValue1() |
ExpressionListHandle |
getValue1ExpressionList()
Gets the value1 expression list of this filter condition.
|
java.util.List |
getValue1List()
Deprecated.
|
java.lang.String |
getValue2()
Returns the value 2 expression of this filter condition.
|
java.lang.String |
getValue2Expr()
Deprecated.
Replaced by the method
getValue2() |
boolean |
isOptional()
Determines whether this filte rcondition is optional or not.
|
boolean |
pushDown()
Indicate if the current filter condition will be pushed down to the
database.
|
void |
setColumn(java.lang.String column)
Deprecated.
This property has been removed.
|
void |
setCustomValue(java.lang.String customValue)
Sets the user specified value.
|
void |
setDynamicFilterParameter(java.lang.String parameterName)
Sets the name of the dynamic filter parameter to reference.
|
void |
setExpr(java.lang.String filterExpr)
Sets the filter expression.
|
void |
setExtensionExprId(java.lang.String extensionExprId)
Sets the id of a custom filter expression contributed and defined by the
extension identified in the consumerExpressionMapping.
|
void |
setExtensionName(java.lang.String extensionName)
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.
|
void |
setFilterExpr(java.lang.String filterExpr)
Deprecated.
Replaced by the method
setExpr(String) |
void |
setFilterTarget(java.lang.String filterTarget)
Sets the filter target.
|
void |
setOperator(java.lang.String operator)
Sets the operator of this filter condition.
|
void |
setOptional(boolean isOptional)
Sets the optional status for this filter condition.
|
void |
setPushDown(boolean pushDown)
Sets the push down status for this filter condition
|
void |
setType(java.lang.String type)
Sets the type of this filter condition.
|
void |
setUpdateAggregation(boolean updateAggregation)
Sets the updateAggregation flag of the filter condition.
|
void |
setValue1(java.util.List value1List)
Sets the value 1 expression list of this filter condition.
|
void |
setValue1(java.lang.String value1Expr)
Sets the value 1 expression of this filter condition.
|
void |
setValue1Expr(java.lang.String value1Expr)
Deprecated.
Replaced by the method
setValue1(String) |
void |
setValue2(Expression value2Expr)
Sets the value 2 expression of this filter condition.
|
void |
setValue2(java.lang.String value2Expr)
Sets the value 2 expression of this filter condition.
|
void |
setValue2Expr(java.lang.String value2Expr)
Deprecated.
Replaced by the method
setValue2(String) |
boolean |
updateAggregation()
Checks if this filter condition needs to update aggregation.
|
drop, getContext, getDefn, getExpressionProperty, getExternalizedValue, getExternalizedValue, getIntProperty, getMember, getProperty, getPropertyDefn, getStringProperty, getStructure, isDesignTime, isLocal, iterator, setDesignTime, setExpressionProperty, setProperty, setPropertySilently
getReference
getDesign, getElement, getElementHandle, getModule
public FilterConditionHandle(SimpleValueHandle valueHandle, int index)
valueHandle
- the value handle for filter condition list of one propertyindex
- the position of this filter condition in the listpublic java.lang.String getExpr()
public void setExpr(java.lang.String filterExpr) throws SemanticException
filterExpr
- the filter expression to setSemanticException
- value required exceptionpublic java.lang.String getOperator()
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
public void setOperator(java.lang.String operator) throws SemanticException
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
operator
- the operator to setSemanticException
- if operator is not in the choice list.public java.lang.String getValue1()
public java.util.List getValue1List()
getValue1ExpressionList()
public ExpressionListHandle getValue1ExpressionList()
public void setValue1(java.lang.String value1Expr)
value1Expr
- the value 1 expression to setpublic void setValue1(java.util.List value1List) throws SemanticException
value1List
- the value 1 expression list to setSemanticException
- if the instance in the list is not validpublic java.lang.String getValue2()
public void setValue2(java.lang.String value2Expr)
value2Expr
- the value 2 expression to setpublic java.lang.String getColumn()
null
. NOT support any more.public void setColumn(java.lang.String column)
column
- the column name to setpublic java.lang.String getFilterExpr()
getExpr()
public void setFilterExpr(java.lang.String filterExpr) throws SemanticException
setExpr(String)
filterExpr
- the filter expression to setSemanticException
- value required exceptionpublic java.lang.String getValue1Expr()
getValue1()
public void setValue1Expr(java.lang.String value1Expr)
setValue1(String)
value1Expr
- the value 1 expression to setpublic java.lang.String getValue2Expr()
getValue2()
public void setValue2Expr(java.lang.String value2Expr)
setValue2(String)
value2Expr
- the value 2 expression to setpublic java.lang.String getFilterTarget()
DesignChoiceConstants
,
and they are:
FILTER_TARGET_DATA_SET
FILTER_TARGET_RESULT_SET
public void setFilterTarget(java.lang.String filterTarget) throws SemanticException
DesignChoiceConstants
,
and they are:
FILTER_TARGET_DATA_SET
FILTER_TARGET_RESULT_SET
filterTarget
- the filter target to setSemanticException
- if the value is not one of the above.public boolean isOptional()
public void setOptional(boolean isOptional)
isOptional
- true if this filter is optional, otherwise falsepublic java.lang.String getExtensionName()
public java.lang.String getExtensionExprId()
public boolean pushDown()
public java.lang.String getDynamicFilterParameter()
public void setExtensionName(java.lang.String extensionName)
extensionName
- the extension name to setpublic void setExtensionExprId(java.lang.String extensionExprId)
extensionExprId
- the id to setpublic void setPushDown(boolean pushDown)
pushDown
- true if the current filter condition will be pushed down to
the database, otherwise false.public void setDynamicFilterParameter(java.lang.String parameterName)
parameterName
- the name of the dynamic filter parameter to setpublic java.lang.String getType()
DesignChoiceConstants
,
and they are:
FILTER_CONDITION_TYPE_SLICER
FILTER_CONDITION_TYPE_SIMPLE
public void setType(java.lang.String type) throws SemanticException
DesignChoiceConstants
,
and they are:
FILTER_CONDITION_TYPE_SLICER
FILTER_CONDITION_TYPE_SIMPLE
type
- the type to setSemanticException
- if type is not in the choice list.public void setValue2(Expression value2Expr) throws SemanticException
value2Expr
- the value 2 expression to setSemanticException
public boolean updateAggregation()
public void setUpdateAggregation(boolean updateAggregation) throws SemanticException
updateAggregation
- the updateAggregation flag to setSemanticException
public java.lang.String getCustomValue()
public void setCustomValue(java.lang.String customValue) throws SemanticException
SemanticException
Copyright © 2008 Actuate Corp. All rights reserved.