com.ibm.as400.util.servlet
Interface RowMetaData

All Known Implementing Classes:

ListMetaData, RecordFormatMetaData, SQLResultSetMetaData

public interface RowMetaData

A RowMetaData object can be used to find out information about the columns of a RowData object.

Method Summary

String	getColumnAlignment(int columnIndex) Returns the horizontal alignment of the column data specified by columnIndex.
int	getColumnCount() Returns the number of columns.
String	getColumnDirection(int columnIndex) Returns the direction of the column data specified by columnIndex.
int	getColumnDisplaySize(int columnIndex) Returns the display size in characters of the column specified by columnIndex.
String	getColumnLabel(int columnIndex) Returns the label of the column specified by columnIndex.
String	getColumnName(int columnIndex) Returns the name of the column specified by columnIndex.
int	getColumnType(int columnIndex) Returns the data type of the column specified by columnIndex.
String	getColumnTypeName(int columnIndex) Returns the data type name of the column specified by columnIndex.
int	getPrecision(int columnIndex) Returns the precision of the column specified by columnIndex.
int	getScale(int columnIndex) Returns the scale of the column specified by columnIndex.
boolean	isNumericData(int columnIndex) Indicates if the column specified by columnIndex contains numeric data.
boolean	isTextData(int columnIndex) Indicates if the column specified by columnIndex contains text data.
void	setColumnAlignment(int columnIndex, String alignment) Sets the specified horizontal alignment for the column data specified by columnIndex.
void	setColumnDirection(int columnIndex, String alignment) Sets the specified direction for the column data specified by columnIndex.
void	setColumnLabel(int columnIndex, String label) Sets the specified label for the column specified by columnIndex.

Method Detail

getColumnAlignment

public String getColumnAlignment(int columnIndex)
                          throws RowDataException

Returns the horizontal alignment of the column data specified by columnIndex. For a list of values, see HTMLConstants.

Parameters:

columnIndex - The column index (0-based).

Returns:

The horizontal column alignment. One of the following constants defined in HTMLConstants: LEFT, CENTER, RIGHT, or JUSTIFY.

Throws:

RowDataException - If a row data error occurred.

getColumnCount

public int getColumnCount()
                   throws RowDataException

Returns the number of columns.

Returns:

The number of columns.

Throws:

RowDataException - If a row data error occurred.

getColumnDirection

public String getColumnDirection(int columnIndex)
                          throws RowDataException

Returns the direction of the column data specified by columnIndex. For a list of values, see HTMLConstants.

Parameters:

columnIndex - The column index (0-based).

Returns:

The direction.

Throws:

RowDataException - If a row data error occurred.

getColumnDisplaySize

public int getColumnDisplaySize(int columnIndex)
                         throws RowDataException

Returns the display size in characters of the column specified by columnIndex.

Parameters:

columnIndex - The column index (0-based).

Returns:

The display size.

Throws:

RowDataException - If a row data error occurred.

getColumnLabel

public String getColumnLabel(int columnIndex)
                      throws RowDataException

Returns the label of the column specified by columnIndex.

Parameters:

columnIndex - The column index(0-based).

Returns:

The label.

Throws:

RowDataException - If a row data error occurred.

getColumnName

public String getColumnName(int columnIndex)
                     throws RowDataException

Returns the name of the column specified by columnIndex.

Parameters:

columnIndex - The column index(0-based).

Returns:

The name.

Throws:

RowDataException - If a row data error occurred.

getColumnType

public int getColumnType(int columnIndex)
                  throws RowDataException

Returns the data type of the column specified by columnIndex. For a list of values, see RowMetaDataType

Parameters:

columnIndex - The column index (0-based).

Returns:

The data type.

Throws:

RowDataException - If a row data error occurred.

getColumnTypeName

public String getColumnTypeName(int columnIndex)
                         throws RowDataException

Returns the data type name of the column specified by columnIndex.

Parameters:

columnIndex - The column index (0-based).

Returns:

The data type name.

Throws:

RowDataException - If a row data error occurred.

getPrecision

public int getPrecision(int columnIndex)
                 throws RowDataException

Returns the precision of the column specified by columnIndex.

Parameters:

columnIndex - The column index (0-based).

Returns:

The precision (number of decimal digits).

Throws:

RowDataException - If a row data error occurred.

getScale

public int getScale(int columnIndex)
             throws RowDataException

Returns the scale of the column specified by columnIndex.

Parameters:

columnIndex - The column index (0-based).

Returns:

The scale (number of digits to the right of the decimal point).

Throws:

RowDataException - If a row data error occurred.

isNumericData

public boolean isNumericData(int columnIndex)
                      throws RowDataException

Indicates if the column specified by columnIndex contains numeric data.

Parameters:

columnIndex - The column index (0-based).

Returns:

true if numeric data; false otherwise.

Throws:

RowDataException - If a row data error occurred.

isTextData

public boolean isTextData(int columnIndex)
                   throws RowDataException

Indicates if the column specified by columnIndex contains text data.

Parameters:

columnIndex - The column index (0-based).

Returns:

true if text data; false otherwise.

Throws:

RowDataException - If a row data error occurred.

setColumnLabel

public void setColumnLabel(int columnIndex,
                           String label)
                    throws RowDataException

Sets the specified label for the column specified by columnIndex.

Parameters:

columnIndex - The column index (0-based).

label - The label.

Throws:

RowDataException - If a row data error occurred.

setColumnAlignment

public void setColumnAlignment(int columnIndex,
                               String alignment)
                        throws RowDataException

Sets the specified horizontal alignment for the column data specified by columnIndex.

Parameters:

columnIndex - The column index (0-based).

alignment - The horizontal column alignment. One of the following constants defined in HTMLConstants: LEFT, CENTER, RIGHT, or JUSTIFY.

Throws:

RowDataException

See Also:

HTMLConstants

setColumnDirection

public void setColumnDirection(int columnIndex,
                               String alignment)
                        throws RowDataException

Sets the specified direction for the column data specified by columnIndex.

Parameters:

columnIndex - The column index (0-based).

alignment - The column direction.

Throws:

RowDataException

See Also:

HTMLConstants