org.springframework.batch.item.excel.support.rowset

Class DefaultRowSet

java.lang.Object

org.springframework.batch.item.excel.support.rowset.DefaultRowSet

All Implemented Interfaces:

RowSet

public class DefaultRowSet
extends java.lang.Object
implements RowSet

Default implementation of the RowSet interface.

Since:

0.5.0

See Also:

DefaultRowSetFactory

Constructor Summary

Constructors

Constructor and Description
DefaultRowSet(Sheet sheet, RowSetMetaData metaData)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getColumnValue(int idx) Retrieves the value of the indicated column in the current row as a String.
java.lang.String[]	getCurrentRow() Return the current row as a String[].
int	getCurrentRowIndex() Returns the current row number
RowSetMetaData	getMetaData() Retrieves the meta data (name of the sheet, number of columns, names) of this row set.
java.util.Properties	getProperties() Construct name-value pairs from the column names and string values.
boolean	next() Move to the next row in the document.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRowSet

public DefaultRowSet(Sheet sheet,
                     RowSetMetaData metaData)

Method Detail

getMetaData

public RowSetMetaData getMetaData()

Description copied from interface: RowSet

Retrieves the meta data (name of the sheet, number of columns, names) of this row set.

Specified by:

getMetaData in interface RowSet

Returns:

a corresponding RowSetMetaData instance.

next

public boolean next()

Description copied from interface: RowSet

Move to the next row in the document.

Specified by:

next in interface RowSet

Returns:

true if the row is valid, false if there are no more rows

getCurrentRowIndex

public int getCurrentRowIndex()

Description copied from interface: RowSet

Returns the current row number

Specified by:

getCurrentRowIndex in interface RowSet

Returns:

the current row number

getCurrentRow

public java.lang.String[] getCurrentRow()

Description copied from interface: RowSet

Return the current row as a String[].

Specified by:

getCurrentRow in interface RowSet

Returns:

the row as a String[]

getColumnValue

public java.lang.String getColumnValue(int idx)

Description copied from interface: RowSet

Retrieves the value of the indicated column in the current row as a String.

Specified by:

getColumnValue in interface RowSet

Parameters:

idx - the column index, 0 based

Returns:

a String respresenting the column value.

getProperties

public java.util.Properties getProperties()

Description copied from interface: RowSet

Construct name-value pairs from the column names and string values. null values are omitted.

Specified by:

getProperties in interface RowSet

Returns:

some properties representing the row set.