mondrian.util
Interface SpatialValueTree2.SpatialRegionRequest

Enclosing interface:

SpatialValueTree2

public static interface SpatialValueTree2.SpatialRegionRequest

A request for a region. The request has a number of dimensions, a subset of the dimensions of the tree, and for each dimension it either requests a list of values or requests all values.

Method Summary

List<SpatialValueTree2.SpatialDimension>	getDimensions() Provides a list of the dimensions included in this region.
Object[]	getValues(SpatialValueTree2.SpatialDimension dimension) Provides an array of objects describing this region's bounds within the specified dimension's axis.
boolean	mightContainCell(Map<SpatialValueTree2.SpatialDimension,Object> coordinates) Returns whether a request might contain a particular cell.

Method Detail

getDimensions

List<SpatialValueTree2.SpatialDimension> getDimensions()

Provides a list of the dimensions included in this region.

Returns:

Dimensions of this region

getValues

Object[] getValues(SpatialValueTree2.SpatialDimension dimension)

Provides an array of objects describing this region's bounds within the specified dimension's axis.

The values are unique and are sorted. The client must not modify the array.

A null array means wildcard. The caller wanted all possible values of this dimension.

Parameters:

dimension - Dimension

Returns:

An array of the bounds touched by this region.

mightContainCell

boolean mightContainCell(Map<SpatialValueTree2.SpatialDimension,Object> coordinates)

Returns whether a request might contain a particular cell.

Parameters:

coordinates - Value for each dimension of cell's coordinates.

Returns:

Whether cell is within the bounds of this request