com.businessobjects.customds.common
Class Row

java.lang.Object
  com.businessobjects.customds.common.Row

public class Row
extends java.lang.Object

The Row class contains the data of the data provider.

Data in the row object is presented in tabular format. Each add operation for the value is associated with a column index. Column index is the position of the column in ColumnsInfo and it is 0 based.

NOTE: Rows added by the plug-in (extension) for a chunk must be homogeneous; that is, all the rows must confirm to the same ColumnSpec for a particular Data Iterator.

Since:

12.2

Constructor Summary

Row(int numberOfColumns)
Class Constructor - The row object must be created by specifying the number of columns for which this Row object contains data.

Method Summary

void	addDate(java.util.Date dValue, int columnIndex) Adds the specified date to the row object at the specified column index.
void	addNumber(java.lang.Number nValue, int columnIndex) Adds the specified number to the row object at the specified column index.
void	addString(java.lang.String strValue, int columnIndex) Adds the specified string value to the Row object at the specified column index.
java.lang.Object[][]	getRowValues() Internal Use Only

Methods inherited from class java.lang.Object

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

Constructor Detail

Row

public Row(int numberOfColumns)
    throws DataSourceException

Class Constructor -

The row object must be created by specifying the number of columns for which this Row object contains data.

Parameters:

numberOfColumns - The number of columns the Row object must contain.

Throws:

DataSourceException - if the number of columns is less than or equal to 0.

Method Detail

addString

public void addString(java.lang.String strValue,
                      int columnIndex)
               throws DataSourceException

Adds the specified string value to the Row object at the specified column index.

Value to be added can be null.

Parameters:

strValue - The String value to be added.

columnIndex - The column index at which the value must be added.

Throws:

DataSourceException - if columnIndex is greater than or equal to the number of columns specified while creating the Row object.

addNumber

public void addNumber(java.lang.Number nValue,
                      int columnIndex)
               throws DataSourceException

Adds the specified number to the row object at the specified column index.

Value to be added can be null.

Parameters:

nValue - The Number value to be added.

columnIndex - The column index at which the value must be added.

Throws:

DataSourceException - if columnIndex is greater than or equal to the number of columns specified while creating the Row object.

addDate

public void addDate(java.util.Date dValue,
                    int columnIndex)
             throws DataSourceException

Adds the specified date to the row object at the specified column index.

Value to be added can be null.

The date value is converted into number of milliseconds since Epoch (01/01/1970 00:00:00 GMT), for further processing.

Parameters:

dValue - The Date value to be added.

columnIndex - The column index at which the value must be added.

Throws:

DataSourceException - if columnIndex is greater than or equal to the number of columns specified while creating the Row object.

getRowValues

public java.lang.Object[][] getRowValues()

Internal Use Only