Package net.sf.jasperreports.olap

Class JROlapDataSource

java.lang.Object

net.sf.jasperreports.olap.JROlapDataSource

All Implemented Interfaces:

JRDataSource, MappingMetadata

Direct Known Subclasses:

JRMondrianDataSource, Olap4jDataSource

public class JROlapDataSource
extends Object
implements JRDataSource, MappingMetadata

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	JROlapDataSource.DataFieldMatcher
protected class	JROlapDataSource.FieldMatcher
protected class	JROlapDataSource.MemberFieldMatcher

Field Summary

Fields

Modifier and Type	Field	Description
protected JROlapResultAxis[]	axes
protected int[]	axisPositions
protected boolean	dataField
static String	EXCEPTION_MESSAGE_KEY_OLAP_AXIS_NOT_FOUND_IN_RESULT
static String	EXCEPTION_MESSAGE_KEY_OLAP_CANNOT_CONVERT_FIELD_TYPE
static String	EXCEPTION_MESSAGE_KEY_OLAP_CANNOT_CONVERT_STRING_VALUE_TYPE
static String	EXCEPTION_MESSAGE_KEY_OLAP_DIMENSION_NOT_FOUND
static String	EXCEPTION_MESSAGE_KEY_OLAP_FIELD_VALUE_NOT_RETRIEVED
static String	EXCEPTION_MESSAGE_KEY_OLAP_INTERNAL_ERROR
static String	EXCEPTION_MESSAGE_KEY_OLAP_INVALID_FIELD_MAPPING
static String	EXCEPTION_MESSAGE_KEY_OLAP_LEVEL_NOT_FOUND
static String	EXCEPTION_MESSAGE_KEY_OLAP_MISSING_FIELD_MAPPING
static String	EXCEPTION_MESSAGE_KEY_OLAP_TUPLE_NOT_FOUND
protected Map<Object,JROlapDataSource.FieldMatcher>	fieldMatchers
protected int[][]	fieldsMaxDepths
protected Map<Object,Object>	fieldValues
protected boolean	first
protected int	hierarchiesCount
protected boolean	iterate
protected boolean[]	iteratePositions
protected int[][]	maxDepths
protected JROlapResult	olapResult
static String	PROPERTY_FIELD_MAPPING	Property specifying the OLAP mapping for the dataset field.
protected JROlapHierarchy[][]	queryHierarchies

Constructor Summary

Constructors

Constructor	Description
JROlapDataSource(JRDataset dataset, JROlapResult result)

Method Summary

Modifier and Type	Method	Description
int	getDimensionIndex(Axis axis, String dimension)
protected String	getFieldMapping(JRField field)
Object	getFieldValue(JRField jrField)	Convert the value of the data type of the Field
int	getLevelDepth(TuplePosition pos, String levelName)
JROlapResult	getOlapResult()
int	getTuplePosition(int axisIndex, Tuple tuple)
protected boolean	matchesDimensionName(JROlapHierarchy hierarchy, String dimensionName)
boolean	next()	Tries to position the cursor on the next element in the data source.
protected boolean	nextPositions()
protected void	processMemberInfo(Member member)
protected void	setMatchMemberDepth(Member memberInfo, JROlapMember member)

Methods inherited from class java.lang.Object

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

Field Detail

EXCEPTION_MESSAGE_KEY_OLAP_AXIS_NOT_FOUND_IN_RESULT

public static final String EXCEPTION_MESSAGE_KEY_OLAP_AXIS_NOT_FOUND_IN_RESULT

See Also:

Constant Field Values

EXCEPTION_MESSAGE_KEY_OLAP_CANNOT_CONVERT_FIELD_TYPE

public static final String EXCEPTION_MESSAGE_KEY_OLAP_CANNOT_CONVERT_FIELD_TYPE

See Also:

Constant Field Values

EXCEPTION_MESSAGE_KEY_OLAP_CANNOT_CONVERT_STRING_VALUE_TYPE

public static final String EXCEPTION_MESSAGE_KEY_OLAP_CANNOT_CONVERT_STRING_VALUE_TYPE

See Also:

Constant Field Values

EXCEPTION_MESSAGE_KEY_OLAP_DIMENSION_NOT_FOUND

public static final String EXCEPTION_MESSAGE_KEY_OLAP_DIMENSION_NOT_FOUND

See Also:

Constant Field Values

EXCEPTION_MESSAGE_KEY_OLAP_FIELD_VALUE_NOT_RETRIEVED

public static final String EXCEPTION_MESSAGE_KEY_OLAP_FIELD_VALUE_NOT_RETRIEVED

See Also:

Constant Field Values

EXCEPTION_MESSAGE_KEY_OLAP_INTERNAL_ERROR

public static final String EXCEPTION_MESSAGE_KEY_OLAP_INTERNAL_ERROR

See Also:

Constant Field Values

EXCEPTION_MESSAGE_KEY_OLAP_MISSING_FIELD_MAPPING

public static final String EXCEPTION_MESSAGE_KEY_OLAP_MISSING_FIELD_MAPPING

See Also:

Constant Field Values

EXCEPTION_MESSAGE_KEY_OLAP_INVALID_FIELD_MAPPING

public static final String EXCEPTION_MESSAGE_KEY_OLAP_INVALID_FIELD_MAPPING

See Also:

Constant Field Values

EXCEPTION_MESSAGE_KEY_OLAP_LEVEL_NOT_FOUND

public static final String EXCEPTION_MESSAGE_KEY_OLAP_LEVEL_NOT_FOUND

See Also:

Constant Field Values

EXCEPTION_MESSAGE_KEY_OLAP_TUPLE_NOT_FOUND

public static final String EXCEPTION_MESSAGE_KEY_OLAP_TUPLE_NOT_FOUND

See Also:

Constant Field Values

PROPERTY_FIELD_MAPPING

public static final String PROPERTY_FIELD_MAPPING

Property specifying the OLAP mapping for the dataset field.

See Also:

Constant Field Values

olapResult

protected final JROlapResult olapResult

axes

protected JROlapResultAxis[] axes

queryHierarchies

protected final JROlapHierarchy[][] queryHierarchies

hierarchiesCount

protected final int hierarchiesCount

fieldMatchers

protected Map<Object,JROlapDataSource.FieldMatcher> fieldMatchers

fieldsMaxDepths

protected int[][] fieldsMaxDepths

iteratePositions

protected boolean[] iteratePositions

iterate

protected boolean iterate

dataField

protected boolean dataField

fieldValues

protected Map<Object,Object> fieldValues

axisPositions

protected int[] axisPositions

first

protected boolean first

maxDepths

protected int[][] maxDepths

Constructor Detail

JROlapDataSource

public JROlapDataSource(JRDataset dataset,
                        JROlapResult result)

Method Detail

getOlapResult

public JROlapResult getOlapResult()

next

public boolean next()
             throws JRException

Description copied from interface: JRDataSource

Tries to position the cursor on the next element in the data source.

Specified by:

next in interface JRDataSource

Returns:

true if there is a next record, false otherwise

Throws:

JRException - if any error occurs while trying to move to the next element

nextPositions

protected boolean nextPositions()

getFieldValue

public Object getFieldValue(JRField jrField)
                     throws JRException

Convert the value of the data type of the Field

Specified by:

getFieldValue in interface JRDataSource

Parameters:

jrField - the Field whose type has to be converted

Returns:

value of field in the requested type

Throws:

JRException

getFieldMapping

protected String getFieldMapping(JRField field)

processMemberInfo

protected void processMemberInfo(Member member)

getDimensionIndex

public int getDimensionIndex(Axis axis,
                             String dimension)

Specified by:

getDimensionIndex in interface MappingMetadata

matchesDimensionName

protected boolean matchesDimensionName(JROlapHierarchy hierarchy,
                                       String dimensionName)

getLevelDepth

public int getLevelDepth(TuplePosition pos,
                         String levelName)

Specified by:

getLevelDepth in interface MappingMetadata

setMatchMemberDepth

protected void setMatchMemberDepth(Member memberInfo,
                                   JROlapMember member)

getTuplePosition

public int getTuplePosition(int axisIndex,
                            Tuple tuple)

Specified by:

getTuplePosition in interface MappingMetadata