Package org.pentaho.commons.connection.memory

Class MemoryResultSet

java.lang.Object

org.pentaho.commons.connection.memory.MemoryResultSet

All Implemented Interfaces:

IDisposable, IMultiDimensionalResultSet, IPeekable, IPentahoResultSet

public class MemoryResultSet
extends Object
implements IPentahoResultSet, IPeekable, IMultiDimensionalResultSet

Field Summary

Fields

Modifier and Type	Field	Description
protected Iterator	iterator
protected Object[]	peekRow
protected int	rowIndex
protected List<Object[]>	rows

Constructor Summary

Constructors

Constructor	Description
MemoryResultSet()
MemoryResultSet(IPentahoMetaData metaData)

Method Summary

Modifier and Type	Method	Description
int	addRow(Object[] row)
void	beforeFirst()	Moves the cursor to before the first row
void	close()	Close the query
void	closeConnection()	Close the connection used by this result set
static MemoryResultSet	createFromActionSequenceInputsNode(org.dom4j.Node rootNode)
static MemoryResultSet	createFromArrays(Object[][] colHeads, Object[][] theRows)
static MemoryResultSet	createFromLists(List colHeaders, List data)
static MemoryResultSet	createList(String name, List items)
void	dispose()	Disposes of this object's resources
int	getColumnCount()	Returns the rowCount from the result set.
Object[]	getDataColumn(int column)	Get a column of data.
Object[]	getDataRow(int row)	Get a specified row of data
IPentahoMetaData	getMetaData()
static String	getNodeText(String xpath, org.dom4j.Node rootNode)
static String	getNodeText(String xpath, org.dom4j.Node rootNode, String defaultValue)
int	getRowCount()	Get a rowCount from the resultset.
List	getRows()
Object	getValueAt(int row, int column)	Returns the value of the specified row and the specified column from within the resultset.
boolean	isScrollable()	Indicates whether the result set is scrollable
IPentahoResultSet	memoryCopy()	Attention: It does not clone data!
Object[]	next()
Object[]	nextFlattened()	Gets the next flattened row.
Object[]	peek()	Peeks into a result set object to get a preview of the next row of data.
Object[]	peekFlattened()	Peeks at the next flattened row.
void	setMetaData(IPentahoMetaData metaData)
void	setRows(List rows)

Methods inherited from class java.lang.Object

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

Field Detail

rows

protected List<Object[]> rows

iterator

protected Iterator iterator

peekRow

protected Object[] peekRow

rowIndex

protected int rowIndex

Constructor Detail

MemoryResultSet

public MemoryResultSet()

MemoryResultSet

public MemoryResultSet(IPentahoMetaData metaData)

Method Detail

setMetaData

public void setMetaData(IPentahoMetaData metaData)

setRows

public void setRows(List rows)

getRows

public List getRows()

addRow

public int addRow(Object[] row)

getMetaData

public IPentahoMetaData getMetaData()

Specified by:

getMetaData in interface IPentahoResultSet

Returns:

the Metadata object that resulted from the most recent query.

peek

public Object[] peek()

Description copied from interface: IPeekable

Peeks into a result set object to get a preview of the next row of data. This is an optional interface that IPentahoResultSet objects can implement

Specified by:

peek in interface IPeekable

Returns:

next

public Object[] next()

Specified by:

next in interface IPentahoResultSet

Returns:

an object array that represents the data in each column of the next row.

close

public void close()

Description copied from interface: IPentahoResultSet

Close the query

Specified by:

close in interface IPentahoResultSet

closeConnection

public void closeConnection()

Description copied from interface: IPentahoResultSet

Close the connection used by this result set

Specified by:

closeConnection in interface IPentahoResultSet

dispose

public void dispose()

Description copied from interface: IDisposable

Disposes of this object's resources

Specified by:

dispose in interface IDisposable

createFromArrays

public static MemoryResultSet createFromArrays(Object[][] colHeads,
                                               Object[][] theRows)

createFromLists

public static MemoryResultSet createFromLists(List colHeaders,
                                              List data)

Parameters:

colHeaders - List of Objects, where each object represents a column header in the metadata of the result set. Most likely will be a List of String.

data - List of (List of Objects). Each List of Objects will become a row of the ResultSet.

Returns:

MemoryResultSet

createList

public static MemoryResultSet createList(String name,
                                         List items)

Parameters:

name -

items - List of Object[] (list of array of objects). Each item in the list will become an row of the ResultSet

Returns:

MemoryResultSet

createFromActionSequenceInputsNode

public static MemoryResultSet createFromActionSequenceInputsNode(org.dom4j.Node rootNode)

getNodeText

public static String getNodeText(String xpath,
                                 org.dom4j.Node rootNode)

getNodeText

public static String getNodeText(String xpath,
                                 org.dom4j.Node rootNode,
                                 String defaultValue)

isScrollable

public boolean isScrollable()

Description copied from interface: IPentahoResultSet

Indicates whether the result set is scrollable

Specified by:

isScrollable in interface IPentahoResultSet

Returns:

true if the resultset can be scrolled through.

getRowCount

public int getRowCount()

Description copied from interface: IPentahoResultSet

Get a rowCount from the resultset.

Specified by:

getRowCount in interface IPentahoResultSet

Returns:

the row count.

getValueAt

public Object getValueAt(int row,
                         int column)

Returns the value of the specified row and the specified column from within the resultset.

Specified by:

getValueAt in interface IPentahoResultSet

Parameters:

row - the row index.

column - the column index.

Returns:

the value.

getColumnCount

public int getColumnCount()

Description copied from interface: IPentahoResultSet

Returns the rowCount from the result set.

Specified by:

getColumnCount in interface IPentahoResultSet

Returns:

memoryCopy

public IPentahoResultSet memoryCopy()

Attention: It does not clone data! It is create the shallow copy of metadata! It is create the shallow copy of data. You must avoid to use this method.

Specified by:

memoryCopy in interface IPentahoResultSet

Returns:

new instance the MemoryResultSet with same metadata

beforeFirst

public void beforeFirst()

Description copied from interface: IPentahoResultSet

Moves the cursor to before the first row

Specified by:

beforeFirst in interface IPentahoResultSet

getDataColumn

public Object[] getDataColumn(int column)

Description copied from interface: IPentahoResultSet

Get a column of data.

Specified by:

getDataColumn in interface IPentahoResultSet

Parameters:

column - the zero based column number

Returns:

array represeting a column of data. 0th element is the first column

getDataRow

public Object[] getDataRow(int row)

Description copied from interface: IPentahoResultSet

Get a specified row of data

Specified by:

getDataRow in interface IPentahoResultSet

Parameters:

row - the zero base row number

Returns:

array representing a row of data. 0th element is the top row

nextFlattened

public Object[] nextFlattened()

Description copied from interface: IMultiDimensionalResultSet

Gets the next flattened row. This includes the row headers (if any)

Specified by:

nextFlattened in interface IMultiDimensionalResultSet

Returns:

peekFlattened

public Object[] peekFlattened()

Description copied from interface: IMultiDimensionalResultSet

Peeks at the next flattened row. This includes the row headers (if any)

Specified by:

peekFlattened in interface IMultiDimensionalResultSet

Returns: