Package net.sf.jasperreports.data.cache

Class ColumnValuesDataSource

java.lang.Object

net.sf.jasperreports.data.cache.ColumnValuesDataSource

All Implemented Interfaces:

IndexedDataSource, JRDataSource, JRRewindableDataSource

public class ColumnValuesDataSource
extends Object
implements JRRewindableDataSource, IndexedDataSource

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field	Description
static String	EXCEPTION_MESSAGE_KEY_INVALID_SNAPSHOT_FIELD_TYPE
static String	EXCEPTION_MESSAGE_KEY_NO_SUCH_SNAPSHOT_FIELD

Constructor Summary

Constructors

Constructor	Description
ColumnValuesDataSource(String[] fieldNames, int size, ColumnValues[] values)

Method Summary

Modifier and Type	Method	Description
Object	getFieldValue(JRField field)	Gets the field value for the current position.
int	getRecordIndex()	Returns the index of the current record in the data source.
void	moveFirst()	Moves back to the first element in the data source.
boolean	next()	Tries to position the cursor on the next element in the data source.

Methods inherited from class java.lang.Object

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

Field Detail

EXCEPTION_MESSAGE_KEY_INVALID_SNAPSHOT_FIELD_TYPE

public static final String EXCEPTION_MESSAGE_KEY_INVALID_SNAPSHOT_FIELD_TYPE

See Also:

Constant Field Values

EXCEPTION_MESSAGE_KEY_NO_SUCH_SNAPSHOT_FIELD

public static final String EXCEPTION_MESSAGE_KEY_NO_SUCH_SNAPSHOT_FIELD

See Also:

Constant Field Values

Constructor Detail

ColumnValuesDataSource

public ColumnValuesDataSource(String[] fieldNames,
                              int size,
                              ColumnValues[] values)

Method Detail

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

getFieldValue

public Object getFieldValue(JRField field)
                     throws DataSnapshotException

Description copied from interface: JRDataSource

Gets the field value for the current position.

Specified by:

getFieldValue in interface JRDataSource

Returns:

an object containing the field value. The object type must be the field object type.

Throws:

DataSnapshotException

moveFirst

public void moveFirst()

Description copied from interface: JRRewindableDataSource

Moves back to the first element in the data source.

Specified by:

moveFirst in interface JRRewindableDataSource

getRecordIndex

public int getRecordIndex()

Description copied from interface: IndexedDataSource

Returns the index of the current record in the data source. Note that this would not necessarily be the same as the index of the record in the order in which the data appears in the report, as after sorting or filtering a data source the original index of the record will be returned.

Specified by:

getRecordIndex in interface IndexedDataSource

Returns:

the index of the current record