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
 int getColumnCount()
          Returns the number of columns.
 int getColumnDisplaySize(int columnIndex)
          Returns the display size in characters of the column specified by columnIndex.
 java.lang.String getColumnLabel(int columnIndex)
          Returns the label of the column specified by columnIndex.
 java.lang.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.
 java.lang.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 setColumnLabel(int columnIndex, java.lang.String label)
          Sets the specified label for the column specified by columnIndex.
 

Method Detail

getColumnCount

public int getColumnCount()
                   throws RowDataException
Returns the number of columns.
Returns:
The number of columns.
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 java.lang.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 java.lang.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 java.lang.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,
                           java.lang.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.