|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.core.Structure
org.eclipse.birt.report.model.core.PropertyStructure
org.eclipse.birt.report.model.api.elements.structures.FilterCondition
public class FilterCondition
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 | |
---|---|
static java.lang.String |
DYNAMIC_FILTER_PARAMETER_MEMBER
Name of the member that indicates the name of the dynamic filter parameter to reference. |
static java.lang.String |
EXPR_MEMBER
Name of the filter expression member. |
static java.lang.String |
EXTENSION_EXPR_ID_MEMBER
Name of the member that indicates the unique id of a custom filter expression contributed and defined by the extension. |
static java.lang.String |
EXTENSION_NAME_MEMBER
Name of the member that indicates the extension name defined to map to a BIRT filter operator. |
static java.lang.String |
FILTER_COND_STRUCT
Name of this structure. |
static java.lang.String |
FILTER_TARGET_MEMBER
Name of the filter target member. |
static java.lang.String |
IS_OPTIONAL_MEMBER
Name of the member that indicates whether this filter is optional or not. |
static java.lang.String |
OPERATOR_MEMBER
Name of the filter operator member. |
static java.lang.String |
PUSH_DOWN_MEMBER
Name of the member that indicates if the current filter condition will be pushed down to the database. |
static java.lang.String |
VALUE1_MEMBER
Name of the filter value 1 expression member. |
static java.lang.String |
VALUE2_MEMBER
Name of the filter value 2 expression member. |
Fields inherited from class org.eclipse.birt.report.model.core.PropertyStructure |
---|
propValues |
Constructor Summary | |
---|---|
FilterCondition()
|
Method Summary | |
---|---|
java.lang.String |
getColumn()
Deprecated. This property has been removed. |
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. |
java.lang.String |
getStructName()
Returns the name of the structure definition. |
java.lang.String |
getValue1()
Returns the value 1 expression. |
java.lang.String |
getValue1Expr()
Deprecated. Replaced by the method getValue1() |
java.util.List |
getValue1ExpressionList()
Gets the value1 expression list of this filter condition. |
java.util.List |
getValue1List()
Deprecated. getValue1ExpressionList() |
java.lang.String |
getValue2()
Returns the value 2 expression. |
java.lang.String |
getValue2Expr()
Deprecated. Replaced by the method getValue2() |
StructureHandle |
handle(SimpleValueHandle valueHandle,
int index)
|
boolean |
isOptional()
Determines whether this filter condition 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 |
setDynamicFilterParameter(java.lang.String parameterName)
Sets the name of the dynamic filter parameter to reference. |
void |
setExpr(java.lang.String expr)
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. |
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 |
setValue1(java.util.List value1List)
Sets the value 1 expression. |
void |
setValue1(java.lang.String value1)
Sets the value 1 expression. |
void |
setValue1Expr(java.lang.String value1Expr)
Deprecated. Replaced by the method setValue1(String) |
void |
setValue2(java.lang.String value2)
Sets the value 2 expression. |
void |
setValue2Expr(java.lang.String value2Expr)
Deprecated. Replaced by the method setValue2(String) |
java.util.List |
validate(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Validates this structure. |
Methods inherited from class org.eclipse.birt.report.model.core.PropertyStructure |
---|
clone, getIntrinsicProperty, getLocalProperty, getLocalProperty, setIntrinsicProperty, setProperty |
Methods inherited from class org.eclipse.birt.report.model.core.Structure |
---|
copy, equals, getCompatibleValue, getContext, getDefn, getElement, getExpressionProperty, getHandle, getHandle, getMemberDefn, getObjectDefn, getProperty, getProperty, getReferencableProperty, getStringProperty, isDesignTime, isReferencable, setContext, setExpressionProperty, setProperty, setupContext, updateReference |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String FILTER_COND_STRUCT
public static final java.lang.String OPERATOR_MEMBER
public static final java.lang.String EXPR_MEMBER
public static final java.lang.String VALUE1_MEMBER
public static final java.lang.String VALUE2_MEMBER
public static final java.lang.String FILTER_TARGET_MEMBER
public static final java.lang.String IS_OPTIONAL_MEMBER
public static final java.lang.String EXTENSION_NAME_MEMBER
public static final java.lang.String EXTENSION_EXPR_ID_MEMBER
public static final java.lang.String PUSH_DOWN_MEMBER
public static final java.lang.String DYNAMIC_FILTER_PARAMETER_MEMBER
Constructor Detail |
---|
public FilterCondition()
Method Detail |
---|
public java.lang.String getStructName()
IStructure
public java.lang.String getExpr()
public void setExpr(java.lang.String expr)
expr
- the filter expression to setpublic 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)
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 setpublic java.lang.String getValue1()
public java.util.List getValue1List()
getValue1ExpressionList()
public java.util.List getValue1ExpressionList()
Expression
object.public void setValue1(java.lang.String value1)
value1
- the value 1 expression to setpublic void setValue1(java.util.List value1List)
value1List
- the value 1 expression list to setpublic java.lang.String getValue2()
public void setValue2(java.lang.String value2)
value2
- the value 2 expression to setpublic java.util.List validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
validate
in class org.eclipse.birt.report.model.core.Structure
Structure.validate(Module,
org.eclipse.birt.report.model.core.DesignElement)
public StructureHandle handle(SimpleValueHandle valueHandle, int index)
handle
in class org.eclipse.birt.report.model.core.Structure
public 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)
setExpr(String)
filterExpr
- the filter expression to setpublic 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)
DesignChoiceConstants
,
and they are:
FILTER_TARGET_DATA_SET
FILTER_TARGET_RESULT_SET
filterTarget
- the filter target to setpublic 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 set
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |