ResultDescription

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> apache >> derby >> iapi >> [ sql overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.apache.derby.iapi.sql.ResultDescription

SOURCE |

Download org.apache.derby.iapi.sql.ResultDescription

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.derby.iapi.sql
Interface ResultDescription

public interface ResultDescription

The ResultDescription interface provides methods to get metadata on the results returned by a statement.

Method Summary

int getColumnCount()
          Returns the number of columns in the result set.

ResultColumnDescriptor getColumnDescriptor(int position)
          Returns a ResultColumnDescriptor for the column, given the oridinal position of the column.

ResultColumnDescriptor[] getColumnInfo()
          Return information about all the columns.

java.lang.String getStatementType()
          Returns an identifier that tells what type of statement has been executed.

ResultDescription truncateColumns(int truncateFrom)
          Get a new result description that has been truncated from input column number.

Method Detail

getStatementType

public java.lang.String getStatementType()

Returns an identifier that tells what type of statement has been executed. This can be used to determine what other methods to call to get the results back from a statement. For example, a SELECT statement returns rows and columns, while other statements don't, so you would only call getColumnCount() or getColumnType() for SELECT statements.

getColumnCount

public int getColumnCount()

Returns the number of columns in the result set.

getColumnInfo

public ResultColumnDescriptor[] getColumnInfo()

Return information about all the columns.

getColumnDescriptor

public ResultColumnDescriptor getColumnDescriptor(int position)

Returns a ResultColumnDescriptor for the column, given the oridinal position of the column. NOTE - position is 1-based.

truncateColumns

public ResultDescription truncateColumns(int truncateFrom)

Get a new result description that has been truncated from input column number. If the input column is 5, then columns 5 to getColumnCount() are removed. The new ResultDescription points to the same ColumnDescriptors (this method performs a shallow copy.