mondrian.rolap
Interface TupleReader

All Known Implementing Classes:

HighCardSqlTupleReader, SqlTupleReader

public interface TupleReader

Describes the public methods of SqlTupleReader.

Since:

Nov 21, 2005

Version:

$Id: //open/mondrian/src/main/mondrian/rolap/TupleReader.java#13 $

Author:

av

Nested Class Summary

static interface

TupleReader.MemberBuilder Factory to create new members for a hierarchy from SQL result.

Method Summary

void	addLevelMembers(RolapLevel level, TupleReader.MemberBuilder memberBuilder, java.util.List<RolapMember> srcMembers) Adds a hierarchy to retrieve members from.
java.lang.Object	getCacheKey() Returns an object that uniquely identifies the Result that this TupleReader would return.
java.util.List<RolapMember>	readMembers(javax.sql.DataSource dataSource, java.util.List<java.util.List<RolapMember>> partialResult, java.util.List<java.util.List<RolapMember>> newPartialResult) Performs the read.
java.util.List<RolapMember[]>	readTuples(javax.sql.DataSource dataSource, java.util.List<java.util.List<RolapMember>> partialResult, java.util.List<java.util.List<RolapMember>> newPartialResult) Performs the read.

Method Detail

addLevelMembers

void addLevelMembers(RolapLevel level,
                     TupleReader.MemberBuilder memberBuilder,
                     java.util.List<RolapMember> srcMembers)

Adds a hierarchy to retrieve members from.

Parameters:

level - level that the members correspond to

memberBuilder - used to build new members for this level

srcMembers - if set, array of enumerated members that make up this level

readTuples

java.util.List<RolapMember[]> readTuples(javax.sql.DataSource dataSource,
                                         java.util.List<java.util.List<RolapMember>> partialResult,
                                         java.util.List<java.util.List<RolapMember>> newPartialResult)

Performs the read.

Returns:

a list of RolapMember[]

readMembers

java.util.List<RolapMember> readMembers(javax.sql.DataSource dataSource,
                                        java.util.List<java.util.List<RolapMember>> partialResult,
                                        java.util.List<java.util.List<RolapMember>> newPartialResult)

Performs the read.

Parameters:

dataSource - source for reading tuples

partialResult - partially cached result that should be used instead of executing sql query

newPartialResult - if non-null, return the result of the read; note that this is a subset of the full return list

Returns:

a list of RolapMember

getCacheKey

java.lang.Object getCacheKey()

Returns an object that uniquely identifies the Result that this TupleReader would return. Clients may use this as a key for caching the result.