org.eclipse.birt.report.model.api
Class FilterConditionHandle

java.lang.Object
  extended by org.eclipse.birt.report.model.api.ElementDetailHandle
      extended by org.eclipse.birt.report.model.api.ValueHandle
          extended by org.eclipse.birt.report.model.api.StructureHandle
              extended by org.eclipse.birt.report.model.api.FilterConditionHandle

public class FilterConditionHandle
extends StructureHandle

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:

Column
a filter condition has a required column.
Operator
a filter condition has a required operator to compute.
Filter Expression
a filter condition has a required filter expression to test. Can be a column or a complete boolean expression.
Value 1 Expression
a filter condition has an optional value 1 expression of the comparison value for all but unary operators.
Value 2 Expression
a filter condition has an optional value 2 expression of the second comparison value for trinary operators(between, not between).


Field Summary
 
Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle
structContext
 
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 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. getValue1ExpressionList()
 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 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.
 
Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle
drop, getContext, getDefn, getExpressionProperty, getExternalizedValue, getExternalizedValue, getIntProperty, getMember, getProperty, getPropertyDefn, getStringProperty, getStructure, isDesignTime, isLocal, iterator, setDesignTime, setExpressionProperty, setProperty, setPropertySilently
 
Methods inherited from class org.eclipse.birt.report.model.api.ValueHandle
getReference
 
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

FilterConditionHandle

public FilterConditionHandle(SimpleValueHandle valueHandle,
                             int index)
Constructs the handle of filter condition.

Parameters:
valueHandle - the value handle for filter condition list of one property
index - the position of this filter condition in the list
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:

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:

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

public java.util.List getValue1List()
Deprecated. 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.

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 handle of this filter condition.

setValue1

public void setValue1(java.lang.String value1Expr)
Sets the value 1 expression of this filter condition.

Parameters:
value1Expr - the value 1 expression to set

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)
Sets the value 2 expression of this filter condition.

Parameters:
value2Expr - the value 2 expression to set

getColumn

public java.lang.String getColumn()
Deprecated. This property has been removed.

Returns the column name of this filter condition.

Returns:
null. NOT support any more.

setColumn

public void setColumn(java.lang.String column)
Deprecated. This property has been removed.

Sets the column name of this filter condition. NOT support any more.

Parameters:
column - the column name to set

getFilterExpr

public java.lang.String getFilterExpr()
Deprecated. Replaced by the method getExpr()

Returns the filter expression.

Returns:
the expression for the filter.

setFilterExpr

public void setFilterExpr(java.lang.String filterExpr)
                   throws SemanticException
Deprecated. Replaced by the method setExpr(String)

Sets the filter expression.

Parameters:
filterExpr - the filter expression to set
Throws:
SemanticException - value required exception

getValue1Expr

public java.lang.String getValue1Expr()
Deprecated. Replaced by the method getValue1()

Returns the value 1 expression of this filter condition.

Returns:
the value 1 expression.

setValue1Expr

public void setValue1Expr(java.lang.String value1Expr)
Deprecated. Replaced by the method setValue1(String)

Sets the value 1 expression of this filter condition.

Parameters:
value1Expr - the value 1 expression to set

getValue2Expr

public java.lang.String getValue2Expr()
Deprecated. Replaced by the method getValue2()

Returns the value 2 expression of this filter condition.

Returns:
the value 2 expression.

setValue2Expr

public void setValue2Expr(java.lang.String value2Expr)
Deprecated. Replaced by the method setValue2(String)

Sets the value 2 expression of this filter condition.

Parameters:
value2Expr - the value 2 expression to set

getFilterTarget

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

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:

Parameters:
filterTarget - the filter target to set
Throws:
SemanticException - if the value is not one of the above.

isOptional

public boolean isOptional()
Determines whether this filte rcondition is optional or not.

Returns:
true if this filter is optional, otherwise false

setOptional

public void setOptional(boolean isOptional)
Sets the optional status for this filter condition.

Parameters:
isOptional - true if this filter is optional, otherwise false

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)
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

setExtensionExprId

public void setExtensionExprId(java.lang.String extensionExprId)
Sets the id of a custom filter expression contributed and defined by the extension identified in the consumerExpressionMapping.

Parameters:
extensionExprId - the id to set

setPushDown

public void setPushDown(boolean pushDown)
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.

setDynamicFilterParameter

public void setDynamicFilterParameter(java.lang.String parameterName)
Sets the name of the dynamic filter parameter to reference.

Parameters:
parameterName - the name of the dynamic filter parameter to set

getType

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

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:

Parameters:
type - the type to set
Throws:
SemanticException - if type is not in the choice list.

setValue2

public void setValue2(Expression value2Expr)
               throws SemanticException
Sets the value 2 expression of this filter condition.

Parameters:
value2Expr - the value 2 expression to set
Throws:
SemanticException

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


Copyright © 2008 Actuate Corp. All rights reserved.