|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.ElementDetailHandle
org.eclipse.birt.report.model.api.ValueHandle
org.eclipse.birt.report.model.api.StructureHandle
org.eclipse.birt.report.model.api.FilterConditionHandle
public class FilterConditionHandle
Represents one filter in the filter list of List, Table or their Groups.
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:
Field Summary |
---|
Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle |
---|
structRef |
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
elementHandle |
Constructor Summary | |
---|---|
FilterConditionHandle(SimpleValueHandle valueHandle,
int index)
Constructs the handle of filter condition. |
Method Summary | |
---|---|
java.lang.String |
getColumn()
Deprecated. This property has been removed. |
java.lang.String |
getExpr()
Returns the filter expression. |
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 |
getValue1()
Returns the value 1 expression of this filter condition. |
java.lang.String |
getValue1Expr()
Deprecated. Replaced by the method getValue1() |
java.util.List |
getValue1List()
Gets the value1 expression list of this filter condition. |
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. |
void |
setColumn(java.lang.String column)
Deprecated. This property has been removed. |
void |
setExpr(java.lang.String filterExpr)
Sets the filter expression. |
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 |
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(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) |
Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle |
---|
drop, getDefn, getExternalizedValue, getMember, getProperty, getPropertyDefn, getReference, getStringProperty, getStructure, isDesignTime, iterator, setDesignTime, setProperty, setPropertySilently |
Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
getDesign, getElement, getElementHandle, getModule |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
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 listMethod Detail |
---|
public java.lang.String getExpr()
public void setExpr(java.lang.String filterExpr) throws SemanticException
filterExpr
- the filter expression to set
SemanticException
- 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 set
SemanticException
- if operator is not in the choice list.public java.lang.String getValue1()
public java.util.List getValue1List()
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 set
SemanticException
- 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 set
SemanticException
- 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 set
SemanticException
- 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 false
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |