Package mondrian.rolap.cache

Class SegmentCacheIndexImpl

java.lang.Object

mondrian.rolap.cache.SegmentCacheIndexImpl

All Implemented Interfaces:

SegmentCacheIndex

public class SegmentCacheIndexImpl
extends Object
implements SegmentCacheIndex

Data structure that identifies which segments contain cells.

Not thread safe.

Author:

Julian Hyde

Constructor Summary

Constructors

Constructor	Description
SegmentCacheIndexImpl(Thread thread)	Creates a SegmentCacheIndexImpl.

Method Summary

Modifier and Type	Method	Description
void	add(SegmentHeader header, SegmentBuilder.SegmentConverter converter, boolean loading)	Adds a header to the index.
void	cancel(Execution exec)	This method must remove all registrations as a client for the given execution.
boolean	contains(SegmentHeader header)	Tells whether or not a given segment is known to this index.
List<List<SegmentHeader>>	findRollupCandidates(String schemaName, ByteString schemaChecksum, String cubeName, String measureName, String rolapStarFactTableName, BitKey constrainedColsBitKey, Map<String,Comparable> coordinates, List<String> compoundPredicates)	Returns a list of segments that can be rolled up to satisfy a given cell request.
SegmentBuilder.SegmentConverter	getConverter(String schemaName, ByteString schemaChecksum, String cubeName, String rolapStarFactTableName, String measureName, List<String> compoundPredicates)	Returns a converter that can convert the given header to internal format.
Future<SegmentBody>	getFuture(Execution exec, SegmentHeader header)	Returns a future slot for a segment body, if a segment is currently loading, otherwise null.
List<SegmentHeader>	intersectRegion(String schemaName, ByteString schemaChecksum, String cubeName, String measureName, String rolapStarFactTableName, SegmentColumn[] region)	Finds a list of headers that intersect a given region.
void	linkSqlStatement(SegmentHeader header, Statement stmt)	Allows to link a Statement to a segment.
void	loadFailed(SegmentHeader header, Throwable throwable)	Notifies the segment index that a segment failed to load, and removes the segment from the index.
void	loadSucceeded(SegmentHeader header, SegmentBody body)	Changes the state of a header from loading to loaded.
List<SegmentHeader>	locate(String schemaName, ByteString schemaChecksum, String cubeName, String measureName, String rolapStarFactTableName, BitKey constrainedColsBitKey, Map<String,Comparable> coordinates, List<String> compoundPredicates)	Identifies the segment headers that contain a given cell.
static List	makeConverterKey(CellRequest request, AggregationKey key)
static List	makeConverterKey(SegmentHeader header)
static boolean	matches(SegmentHeader header, Map<String,Comparable> coords, List<String> compoundPredicates)
void	printCacheState(PrintWriter pw)	Prints the state of the cache to the given writer.
void	remove(SegmentHeader header)	Removes a header from the index.
void	setConverter(String schemaName, ByteString schemaChecksum, String cubeName, String rolapStarFactTableName, String measureName, List<String> compoundPredicates, SegmentBuilder.SegmentConverter converter)	Sets a converter that can convert headers in for a given measure to internal format.
void	update(SegmentHeader oldHeader, SegmentHeader newHeader)	Updates a header in the index.

Methods inherited from class java.lang.Object

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

Constructor Detail

SegmentCacheIndexImpl

public SegmentCacheIndexImpl(Thread thread)

Creates a SegmentCacheIndexImpl.

Parameters:

thread - Thread that must be used to execute commands.

Method Detail

makeConverterKey

public static List makeConverterKey(SegmentHeader header)

makeConverterKey

public static List makeConverterKey(CellRequest request,
                                    AggregationKey key)

locate

public List<SegmentHeader> locate(String schemaName,
                                  ByteString schemaChecksum,
                                  String cubeName,
                                  String measureName,
                                  String rolapStarFactTableName,
                                  BitKey constrainedColsBitKey,
                                  Map<String,Comparable> coordinates,
                                  List<String> compoundPredicates)

Description copied from interface: SegmentCacheIndex

Identifies the segment headers that contain a given cell.

Specified by:

locate in interface SegmentCacheIndex

Parameters:

schemaName - Schema name

schemaChecksum - Schema checksum

cubeName - Cube name

measureName - Measure name

rolapStarFactTableName - Fact table table

constrainedColsBitKey - Bit key

coordinates - Coordinates

compoundPredicates - Compound predicates

Returns:

Empty list if not found; never null

add

public void add(SegmentHeader header,
                SegmentBuilder.SegmentConverter converter,
                boolean loading)

Description copied from interface: SegmentCacheIndex

Adds a header to the index.

Specified by:

add in interface SegmentCacheIndex

Parameters:

header - Segment header

converter - Segment converter

loading - Whether segment is pending a load from SQL

update

public void update(SegmentHeader oldHeader,
                   SegmentHeader newHeader)

Description copied from interface: SegmentCacheIndex

Updates a header in the index. This is required when some of the excluded regions have changed.

Specified by:

update in interface SegmentCacheIndex

Parameters:

oldHeader - The old header to replace.

newHeader - The new header to use instead.

loadSucceeded

public void loadSucceeded(SegmentHeader header,
                          SegmentBody body)

Description copied from interface: SegmentCacheIndex

Changes the state of a header from loading to loaded.

The segment must have previously been added by calling SegmentCacheIndex.add(mondrian.spi.SegmentHeader, mondrian.rolap.agg.SegmentBuilder.SegmentConverter, boolean) with a not-null value of the bodyFuture parameter; neither loadSucceeded nor SegmentCacheIndex.loadFailed(mondrian.spi.SegmentHeader, java.lang.Throwable) must have been called.

Informs anyone waiting on the future supplied with SegmentCacheIndex.add(mondrian.spi.SegmentHeader, mondrian.rolap.agg.SegmentBuilder.SegmentConverter, boolean).

Specified by:

loadSucceeded in interface SegmentCacheIndex

Parameters:

header - Segment header

body - Segment body

loadFailed

public void loadFailed(SegmentHeader header,
                       Throwable throwable)

Description copied from interface: SegmentCacheIndex

Notifies the segment index that a segment failed to load, and removes the segment from the index.

The segment must have previously been added using SegmentCacheIndex.add(mondrian.spi.SegmentHeader, mondrian.rolap.agg.SegmentBuilder.SegmentConverter, boolean) with a not-null value of the bodyFuture parameter; neither SegmentCacheIndex.loadSucceeded(mondrian.spi.SegmentHeader, mondrian.spi.SegmentBody) nor loadFailed must have been called.

Informs anyone waiting on the future supplied with SegmentCacheIndex.add(mondrian.spi.SegmentHeader, mondrian.rolap.agg.SegmentBuilder.SegmentConverter, boolean).

Specified by:

loadFailed in interface SegmentCacheIndex

Parameters:

header - Header

throwable - Error message

remove

public void remove(SegmentHeader header)

Description copied from interface: SegmentCacheIndex

Removes a header from the index.

Specified by:

remove in interface SegmentCacheIndex

Parameters:

header - Segment header

matches

public static boolean matches(SegmentHeader header,
                              Map<String,Comparable> coords,
                              List<String> compoundPredicates)

intersectRegion

public List<SegmentHeader> intersectRegion(String schemaName,
                                           ByteString schemaChecksum,
                                           String cubeName,
                                           String measureName,
                                           String rolapStarFactTableName,
                                           SegmentColumn[] region)

Description copied from interface: SegmentCacheIndex

Finds a list of headers that intersect a given region.

This method is used to find out which headers need to be trimmed or removed during a flush.

Specified by:

intersectRegion in interface SegmentCacheIndex

Parameters:

schemaName - Schema name

schemaChecksum - Schema checksum

cubeName - Cube name

measureName - Measure name

rolapStarFactTableName - Fact table table

region - Region

Returns:

List of intersecting headers

printCacheState

public void printCacheState(PrintWriter pw)

Description copied from interface: SegmentCacheIndex

Prints the state of the cache to the given writer.

Specified by:

printCacheState in interface SegmentCacheIndex

Parameters:

pw - Print writer

getFuture

public Future<SegmentBody> getFuture(Execution exec,
                                     SegmentHeader header)

Description copied from interface: SegmentCacheIndex

Returns a future slot for a segment body, if a segment is currently loading, otherwise null. This is the method to use to get segments 'hot out of the oven'.

When this method is invoked, the execution instance of the thread is automatically added to the list of clients for the given segment. The calling code is responsible for calling SegmentCacheIndex.cancel(Execution) when it is done with the segments, or else this registration will prevent others from canceling the running SQL statements associated to this segment.

Specified by:

getFuture in interface SegmentCacheIndex

header - Segment header

Returns:

Slot, or null

linkSqlStatement

public void linkSqlStatement(SegmentHeader header,
                             Statement stmt)

Description copied from interface: SegmentCacheIndex

Allows to link a Statement to a segment. This allows the index to cleanup when SegmentCacheIndex.cancel(Execution) is invoked and orphaned segments are left.

Specified by:

linkSqlStatement in interface SegmentCacheIndex

Parameters:

header - The segment.

stmt - The SQL statement.

contains

public boolean contains(SegmentHeader header)

Description copied from interface: SegmentCacheIndex

Tells whether or not a given segment is known to this index.

Specified by:

contains in interface SegmentCacheIndex

cancel

public void cancel(Execution exec)

Description copied from interface: SegmentCacheIndex

This method must remove all registrations as a client for the given execution. This must terminate all SQL activity for any orphaned segments.

Specified by:

cancel in interface SegmentCacheIndex

Parameters:

exec - The execution to unregister.

getConverter

public SegmentBuilder.SegmentConverter getConverter(String schemaName,
                                                    ByteString schemaChecksum,
                                                    String cubeName,
                                                    String rolapStarFactTableName,
                                                    String measureName,
                                                    List<String> compoundPredicates)

Description copied from interface: SegmentCacheIndex

Returns a converter that can convert the given header to internal format.

Specified by:

getConverter in interface SegmentCacheIndex

Parameters:

schemaName - Schema name

schemaChecksum - Schema checksum

cubeName - Cube name

rolapStarFactTableName - Fact table

measureName - Measure name

compoundPredicates - Compound predicates

Returns:

Converter

setConverter

public void setConverter(String schemaName,
                         ByteString schemaChecksum,
                         String cubeName,
                         String rolapStarFactTableName,
                         String measureName,
                         List<String> compoundPredicates,
                         SegmentBuilder.SegmentConverter converter)

Description copied from interface: SegmentCacheIndex

Sets a converter that can convert headers in for a given measure to internal format.

Specified by:

setConverter in interface SegmentCacheIndex

Parameters:

schemaName - Schema name

schemaChecksum - Schema checksum

cubeName - Cube name

rolapStarFactTableName - Fact table

measureName - Measure name

compoundPredicates - Compound predicates

converter - Converter to store

findRollupCandidates

public List<List<SegmentHeader>> findRollupCandidates(String schemaName,
                                                      ByteString schemaChecksum,
                                                      String cubeName,
                                                      String measureName,
                                                      String rolapStarFactTableName,
                                                      BitKey constrainedColsBitKey,
                                                      Map<String,Comparable> coordinates,
                                                      List<String> compoundPredicates)

Description copied from interface: SegmentCacheIndex

Returns a list of segments that can be rolled up to satisfy a given cell request.

Specified by:

findRollupCandidates in interface SegmentCacheIndex

Parameters:

schemaName - Schema name

schemaChecksum - Schema checksum

cubeName - Cube name

measureName - Measure name

rolapStarFactTableName - Fact table table

constrainedColsBitKey - Bit key

coordinates - Coordinates

compoundPredicates - Compound predicates

Returns:

List of candidates; each element is a list of headers that, when combined using union, are sufficient to answer the given cell request