mondrian.spi

Interface SegmentBody

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractSegmentBody, DenseDoubleSegmentBody, DenseIntSegmentBody, DenseObjectSegmentBody, SparseSegmentBody

public interface SegmentBody
extends Serializable

SegmentBody is the object which contains the cached data of a Segment. They are stored inside a SegmentCache and can be retrieved by a SegmentHeader key.

The segment body objects are immutable and fully serializable.

Author:

LBoudreau

Method Summary

Modifier and Type	Method and Description
SortedSet<Comparable>[]	getAxisValueSets() Returns the cached axis value sets to be used as an initializer for the segment's axis.
boolean[]	getNullAxisFlags() Returns an array of boolean values which identify which axis of the cached segment contained null values.
BitSet	getNullValueIndicators() Returns a bit-set indicating whether values are null.
Object	getValueArray() Returns an array of values.
Map<CellKey,Object>	getValueMap() Converts contents of this segment into a cellkey/value map.

Method Detail

getValueMap

Map<CellKey,Object> getValueMap()

Converts contents of this segment into a cellkey/value map. Use only for sparse segments.

Returns:

Map containing cell values keyed by their coordinates

getValueArray

Object getValueArray()

Returns an array of values.

Use only for dense segments.

Returns:

An array of values

getNullValueIndicators

BitSet getNullValueIndicators()

Returns a bit-set indicating whether values are null. The ordinals in the bit-set correspond to the indexes in the array returned from getValueArray().

Use only for dense segments of native values.

Returns:

Indicators

getAxisValueSets

SortedSet<Comparable>[] getAxisValueSets()

Returns the cached axis value sets to be used as an initializer for the segment's axis.

Returns:

An array of SortedSets which was cached previously.

getNullAxisFlags

boolean[] getNullAxisFlags()

Returns an array of boolean values which identify which axis of the cached segment contained null values.

Returns:

An array of boolean values.