org.eclipse.birt.data.engine.api
Interface IFilterDefinition

All Known Implementing Classes:
FilterDefinition

public interface IFilterDefinition

Describes a data row filter defined in a data set or a report query. A filter is defined as an expression that returns a Boolean type. The expression normally operates on the "row" Javascript object to apply conditions based on column values of a data row.


Nested Class Summary
static class IFilterDefinition.FilterTarget
           
 
Method Summary
 IBaseExpression getExpression()
          Gets the Boolean expression used to define this filter.
 IFilterDefinition.FilterTarget getFilterTarget()
          get the filter target
 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.
 

Method Detail

getExpression

IBaseExpression getExpression()
Gets the Boolean expression used to define this filter.


updateAggregation

boolean updateAggregation()
Indicate whether the aggreation will be recalculated after this filter has been applied.

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

setUpdateAggregation

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.

Parameters:
update -

getFilterTarget

IFilterDefinition.FilterTarget getFilterTarget()
get the filter target

Returns:

setFilterTarget

void setFilterTarget(IFilterDefinition.FilterTarget filterTarget)
set filter target

Parameters:
filterTarget -


Copyright © 2008 Actuate Corp. All rights reserved.