com.sas.table
Interface FormattedDataInterface

All Superinterfaces:
StaticFormattedDataInterface
All Known Subinterfaces:
DataTableInterface
All Known Implementing Classes:
JDBCToDataTableAdapter

public interface FormattedDataInterface
extends StaticFormattedDataInterface

Defines an interface for modifying a table's formatted data.

See Also:
TableInterface

Method Summary
 void setFormattedCell(int rowIndex, int columnIndex, java.lang.String value)
          Specifies the formatted value of a cell.
 void setFormattedCells(int startRowIndex, int startColumnIndex, int rowCount, int columnCount, java.lang.String[][] values)
          Specifies the formatted values for a block of cells.
 void setFormattedColumn(int index, java.lang.String[] values)
          Specifies the formatted values of all the cells in a column.
 void setFormattedRow(int index, java.lang.String[] values)
          Specifies the formatted values of all the cells in a row.
 
Methods inherited from interface com.sas.table.StaticFormattedDataInterface
getFormattedCell, getFormattedCells, getFormattedColumn, getFormattedRow
 

Method Detail

setFormattedCell

void setFormattedCell(int rowIndex,
                      int columnIndex,
                      java.lang.String value)
                      throws com.sas.table.TableException
Specifies the formatted value of a cell. The cell is identified by the given row and column indices.

Parameters:
rowIndex - A one-based index that identifies the cell's row.
columnIndex - A one-based index that identifies the cell's column.
value - The cell's new formatted value.
Throws:
TableException - Thrown if the query can not be satisfied (e.g. i/o-failure).
java.lang.IndexOutOfBoundsException - Thrown if rowIndex is negative, zero, or greater than the number of rows. Thrown if columnIndex is negative, zero, or greater than the number of columns.
See Also:
setFormattedCells(int, int, int, int, java.lang.String[][]), setFormattedColumn(int, java.lang.String[]), setFormattedRow(int, java.lang.String[])

setFormattedCells

void setFormattedCells(int startRowIndex,
                       int startColumnIndex,
                       int rowCount,
                       int columnCount,
                       java.lang.String[][] values)
                       throws com.sas.table.TableException
Specifies the formatted values for a block of cells. The block is identified by the intersection of a range of rows with a range of columns. startRowIndex and rowCount define the start and extent of the row range while startColumnIndex and columnCount define the column range. The set of formatted values is specified as a two-dimensional array, new Object[rowCount][colCount], with values[0][0] containing the value of the cell at (startRowIndex, startColumnIndex).

Parameters:
startRowIndex - A one-based index that identifies the start of the row range.
startColumnIndex - A one-based index that identifies the start of the column range.
rowCount - The number of rows in the row range.
columnCount - The number of columns in the column range.
values - The new formatted values for each cell in the block.
Throws:
TableException - Thrown if the query can not be satisfied (e.g. i/o-failure).
java.lang.IndexOutOfBoundsException - Thrown if startRowIndex or rowCount is negative, zero, or greater than the number of rows. Thrown if startColumnIndex or columnCount is negative, zero, or greater than the number of columns.
See Also:
setFormattedCell(int, int, java.lang.String)

setFormattedColumn

void setFormattedColumn(int index,
                        java.lang.String[] values)
                        throws com.sas.table.TableException
Specifies the formatted values of all the cells in a column. The column is identified by the given index. The set of formatted values is specified as an array with each element of the array corresponding to a cell in the column.

Parameters:
index - A one-based index that identifies the column.
values - The new formatted values for each cell in the column.
Throws:
TableException - Thrown if the query can not be satisfied (e.g. i/o-failure).
java.lang.IndexOutOfBoundsException - Thrown if index is negative, zero, or greater than the number of columns.
See Also:
setFormattedCell(int, int, java.lang.String)

setFormattedRow

void setFormattedRow(int index,
                     java.lang.String[] values)
                     throws com.sas.table.TableException
Specifies the formatted values of all the cells in a row. The row is identified by the given index. The set of formatted values is specified as an array with each element of the array corresponding to a cell in the row.

Parameters:
index - A one-based index that identifies the row.
values - The new formatted values for each cell in the row.
Throws:
TableException - Thrown if the query can not be satisfied (e.g. i/o-failure).
java.lang.IndexOutOfBoundsException - Thrown if index is negative, zero, or greater than the number of rows.
See Also:
setFormattedCell(int, int, java.lang.String)



Copyright © 2009 SAS Institute Inc. All Rights Reserved.