org.eclipse.birt.data.engine.api.querydefn
Class FilterDefinition

java.lang.Object
  org.eclipse.birt.data.engine.api.querydefn.FilterDefinition

All Implemented Interfaces:

IFilterDefinition

public class FilterDefinition
extends java.lang.Object
implements IFilterDefinition

Default implementation of IFilterDefinition interface.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.birt.data.engine.api.IFilterDefinition

IFilterDefinition.FilterTarget

Constructor Summary

FilterDefinition(IBaseExpression filterExpr)
Constructs a new filter using the specified expression.

FilterDefinition(IBaseExpression filterExpr, boolean updateAggr)
Constructs a new filter with filter expression and update option.

Method Summary

IBaseExpression	getExpression() Gets the Boolean expression used to define this filter.
IFilterDefinition.FilterTarget	getFilterTarget() get the filter target
void	setExpression(IBaseExpression filterExpr) Sets a new expression for the filter.
void	setFilterTarget(IFilterDefinition.FilterTarget filterTarget) set filter target
void	setUpdateAggregation(boolean flag) Set update aggregation flag.
boolean	updateAggregation() Indicate whether the aggreation will be recalculated after this filter has been applied.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilterDefinition

public FilterDefinition(IBaseExpression filterExpr)

Constructs a new filter using the specified expression. The expression is expected to return a Boolean value at runtime to be used as the filtering criteria.

FilterDefinition

public FilterDefinition(IBaseExpression filterExpr,
                        boolean updateAggr)

Constructs a new filter with filter expression and update option.

Parameters:

filterExpr - Filter evaluate expression

updateAggr - While true, the aggregation values are updated prior to apply this filter; Otherwise the aggregation values are not updated.

Method Detail

getExpression

public IBaseExpression getExpression()

Description copied from interface: IFilterDefinition

Gets the Boolean expression used to define this filter.

Specified by:

getExpression in interface IFilterDefinition

See Also:

IFilterDefinition.getExpression()

setExpression

public void setExpression(IBaseExpression filterExpr)

Sets a new expression for the filter.

updateAggregation

public boolean updateAggregation()

Description copied from interface: IFilterDefinition

Indicate whether the aggreation will be recalculated after this filter has been applied.

Specified by:

updateAggregation in interface IFilterDefinition

Returns:

true if the aggregation values should be updated prior to apply this filter; Otherwise, return false.

setUpdateAggregation

public void setUpdateAggregation(boolean flag)

Set update aggregation flag.

While the flag is true, the aggregation values are updated prior to apply this filter; Otherwise the aggregation values are not updated.

Specified by:

setUpdateAggregation in interface IFilterDefinition

Parameters:

update -

getFilterTarget

public IFilterDefinition.FilterTarget getFilterTarget()

Description copied from interface: IFilterDefinition

get the filter target

Specified by:

getFilterTarget in interface IFilterDefinition

Returns:

setFilterTarget

public void setFilterTarget(IFilterDefinition.FilterTarget filterTarget)

Description copied from interface: IFilterDefinition

set filter target

Specified by:

setFilterTarget in interface IFilterDefinition