com.sas.table
Interface RowLabelInterface

All Superinterfaces:

com.sas.table.StaticRowLabelInterface

public interface RowLabelInterface
extends com.sas.table.StaticRowLabelInterface

Defines an interface for modifying a table's row labels.

See Also:

TableInterface, ColumnLabelInterface

Method Summary

boolean	isRowLabelsModifiable() Indicates whether row labels can be modified.
void	setRowLabel(int index, java.lang.Object label) Specifies the label to associate with a row.

Methods inherited from interface com.sas.table.StaticRowLabelInterface

getRowLabel, getRowLabels, isRowLabelsSupported, isRowsLabelSupported

Method Detail

isRowLabelsModifiable

boolean isRowLabelsModifiable()

Indicates whether row labels can be modified. Normally the act of implementing this interface would indicate that labels can be modified, but some implementations may have read-only modes.

Returns:

true if row labels can be modified, and false otherwise.

setRowLabel

void setRowLabel(int index,
                 java.lang.Object label)
                 throws com.sas.table.TableException

Specifies the label to associate with a row. The row is identified by a given index

When isRowsLabelSupported() is true, setRowLabel(0) can be used to set the label for the entire set of row labels.

Parameters:

index - A one-based index that identifies the row. See note about use of zero above.

label - The row's new label.

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 note about use of zero above.

See Also:

StaticRowLabelInterface.isRowsLabelSupported()