mondrian.rolap
Class RolapCacheRegion

java.lang.Object
  mondrian.rolap.RolapCacheRegion

public class RolapCacheRegion
extends Object

A RolapCacheRegion represents a region of multidimensional space in the cache.

The region is represented in terms of the columns of a given RolapStar, and constraints on those columns.

Compare with CacheControl.CellRegion: a CellRegion is in terms of Member objects (logical); whereas a RolapCacheRegion is in terms of columns (physical).

Constructor Summary

RolapCacheRegion(RolapStar star, List<RolapStar.Measure> starMeasureList)

Method Summary

void	addPredicate(RolapStar.Column column, StarColumnPredicate predicate) Adds a predicate which applies to a single column.
void	addPredicate(StarPredicate predicate) Adds a predicate which applies to multiple columns.
Collection<StarColumnPredicate>	getColumnPredicates() Returns the list of all column predicates.
BitKey	getConstrainedColumnsBitKey()
StarColumnPredicate	getPredicate(int columnOrdinal) Returns the predicate associated with the columnOrdinalth column.
StarColumnPredicate	getPredicate(String columnName) Returns the predicate associated with the columnName, where column name is the generic SQL expression in the form of:
Collection<StarPredicate>	getPredicates() Returns a collection of all multi-column predicates.

Methods inherited from class java.lang.Object

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

Constructor Detail

RolapCacheRegion

public RolapCacheRegion(RolapStar star,
                        List<RolapStar.Measure> starMeasureList)

Method Detail

getConstrainedColumnsBitKey

public BitKey getConstrainedColumnsBitKey()

addPredicate

public void addPredicate(RolapStar.Column column,
                         StarColumnPredicate predicate)

Adds a predicate which applies to a single column.

Parameters:

column - Constrained column

predicate - Predicate

getPredicate

public StarColumnPredicate getPredicate(int columnOrdinal)

Returns the predicate associated with the columnOrdinalth column.

Parameters:

columnOrdinal - Column ordinal

Returns:

Predicate, or null if not constrained

getPredicate

public StarColumnPredicate getPredicate(String columnName)

Returns the predicate associated with the columnName, where column name is the generic SQL expression in the form of:

table.column

Parameters:

columnName - Column name

Returns:

Predicate, or null if not constrained

addPredicate

public void addPredicate(StarPredicate predicate)

Adds a predicate which applies to multiple columns.

The typical example of a multi-column predicate is a member constraint. For example, the constraint "m between 1997.Q3 and 1998.Q2" translates into "year = 1997 and quarter >= Q3 or year = 1998 and quarter <= Q2".

Parameters:

predicate - Predicate

getPredicates

public Collection<StarPredicate> getPredicates()

Returns a collection of all multi-column predicates.

Returns:

Collection of all multi-column constraints

getColumnPredicates

public Collection<StarColumnPredicate> getColumnPredicates()

Returns the list of all column predicates.