Top Description Methods
org.apache.derby.iapi.sql

public Interface ResultDescription

Known Direct Implementers
org.apache.derby.impl.sql.GenericResultDescription

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

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

Position of the column (1-based), -1 if no match.
findColumnInsenstive
(String
The column name
name
)

Return the position of the column matching the passed in names following the JDBC rules for ResultSet.getXXX and updateXXX.

public int

Returns:

The number of columns in the result set.
getColumnCount
()

Returns the number of columns in the result set.

public ResultColumnDescriptor

Returns:

A ResultColumnDescriptor describing the column in the ResultSet.
getColumnDescriptor
(int
The oridinal position of a column in the ResultSet.
position
)

Returns a ResultColumnDescriptor for the column, given the ordiinal position of the column.

public ResultColumnDescriptor[]

Returns:

information about all the columns
getColumnInfo
()

Return information about all the columns.

public ResultColumnDescriptor

Returns:

The column descriptor
getColumnInfo
(int
The column index
idx
)

Return the information about a single column (0-based indexing)

public ResultSetMetaData

Returns:

the metadata
getMetaData
()

Get the saved JDBC ResultSetMetaData.

public String

Returns:

A String identifier telling what type of statement this is.
getStatementType
()

Returns an identifier that tells what type of statement has been executed.

public void
setMetaData(ResultSetMetaData
The metadata to set
rsmd
)

Set the JDBC ResultSetMetaData for this ResultDescription.

public ResultDescription

Returns:

a new ResultDescription
truncateColumns
(int
the starting column to remove, 1-based.
truncateFrom
)

Get a new result description that has been truncated from input column number.

Method Detail

findColumnInsenstiveback to summary
public int findColumnInsenstive(String name)

Return the position of the column matching the passed in names following the JDBC rules for ResultSet.getXXX and updateXXX. Rules are the matching is case insensitive and the insensitive name matches the first column found that matches (starting at postion 1).

Parameters
name:String

The column name

Returns:int

Position of the column (1-based), -1 if no match.

getColumnCountback to summary
public int getColumnCount()

Returns the number of columns in the result set.

Returns:int

The number of columns in the result set.

getColumnDescriptorback to summary
public ResultColumnDescriptor getColumnDescriptor(int position)

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

Parameters
position:int

The oridinal position of a column in the ResultSet.

Returns:ResultColumnDescriptor

A ResultColumnDescriptor describing the column in the ResultSet.

getColumnInfoback to summary
public ResultColumnDescriptor[] getColumnInfo()

Return information about all the columns.

Returns:ResultColumnDescriptor[]

information about all the columns

getColumnInfoback to summary
public ResultColumnDescriptor getColumnInfo(int idx)

Return the information about a single column (0-based indexing)

Parameters
idx:int

The column index

Returns:ResultColumnDescriptor

The column descriptor

getMetaDataback to summary
public ResultSetMetaData getMetaData()

Get the saved JDBC ResultSetMetaData. Will return null if setMetaData() has not been called on this object. The caller then should manufacture a ResultSetMetaData object and pass it into setMetaData.

Returns:ResultSetMetaData

the metadata

getStatementTypeback to summary
public 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.

Returns:String

A String identifier telling what type of statement this is.

setMetaDataback to summary
public void setMetaData(ResultSetMetaData rsmd)

Set the JDBC ResultSetMetaData for this ResultDescription. A ResultSetMetaData object can be saved in the statement plan using this method. This only works while the ResultSetMetaData api does not contain a getConnection() method or a close method.
If this object already has a saved meta data object this call will do nothing. Due to synchronization the saved ResultSetMetaData object may not be the one passed in, ie. if two threads call this concurrently, only one will be saved. It is assumed the JDBC layer passes in a ResultSetMetaData object based upon this.

Parameters
rsmd:ResultSetMetaData

The metadata to set

truncateColumnsback to summary
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. The saved JDBC ResultSetMetaData will not be copied.

Parameters
truncateFrom:int

the starting column to remove, 1-based.

Returns:ResultDescription

a new ResultDescription