org.apache.derby.impl.sql
Class GenericResultDescription

java.lang.Object
  org.apache.derby.impl.sql.GenericResultDescription

All Implemented Interfaces:

java.io.Externalizable, Formatable, ResultDescription, java.io.Serializable, TypedFormat

public final class GenericResultDescription

extends java.lang.Object

implements ResultDescription, Formatable

GenericResultDescription: basic implementation of result description, used in conjunction with the other implementations in this package. This implementation of ResultDescription may be used by anyone.

Author:

ames

See Also:

Serialized Form

Field Summary

private ResultColumnDescriptor[]	columns This class implements Formatable.
private java.lang.String	statementType

Constructor Summary

GenericResultDescription()
Niladic constructor for Formatable

GenericResultDescription(ResultColumnDescriptor[] columns, java.lang.String statementType)
Build a GenericResultDescription from columns and type

GenericResultDescription(ResultDescription rd, int[] theCols)
Build a GenericResultDescription

Method Summary

int	getColumnCount() Returns the number of columns in the result set.
ResultColumnDescriptor	getColumnDescriptor(int position) position is 1-based.
ResultColumnDescriptor[]	getColumnInfo() Return information about all the columns.
java.lang.String	getStatementType() Returns an identifier that tells what type of statement has been executed.
int	getTypeFormatId() Get the formatID which corresponds to this class.
void	readExternal(java.io.ObjectInput in) Read this object from a stream of stored objects.
java.lang.String	toString()
ResultDescription	truncateColumns(int truncateFrom) Get a new result description that has been truncated from input column number.
void	writeExternal(java.io.ObjectOutput out) Write this object out

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

columns

private ResultColumnDescriptor[] columns

This class implements Formatable. That means that it can write itself to and from a formatted stream. If you add more fields to this class, make sure that you also write/read them with the writeExternal()/readExternal() methods. If, inbetween releases, you add more fields to this class, then you should bump the version number emitted by the getTypeFormatId() method.

statementType

private java.lang.String statementType

Constructor Detail

GenericResultDescription

public GenericResultDescription()

Niladic constructor for Formatable

GenericResultDescription

public GenericResultDescription(ResultColumnDescriptor[] columns,
                                java.lang.String statementType)

Build a GenericResultDescription from columns and type

Parameters:

columns - an array of col descriptors

statementType - the type

GenericResultDescription

public GenericResultDescription(ResultDescription rd,
                                int[] theCols)

Build a GenericResultDescription

Parameters:

rd - the result description

theCols - the columns to take from the input rd

Method Detail

getStatementType

public java.lang.String getStatementType()

Description copied from interface: ResultDescription

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.

Specified by:

getStatementType in interface ResultDescription

Returns:

A String identifier telling what type of statement this is.

See Also:

ResultDescription.getStatementType()

getColumnCount

public int getColumnCount()

Description copied from interface: ResultDescription

Returns the number of columns in the result set.

Specified by:

getColumnCount in interface ResultDescription

Returns:

The number of columns in the result set.

See Also:

ResultDescription.getColumnCount()

getColumnInfo

public ResultColumnDescriptor[] getColumnInfo()

Description copied from interface: ResultDescription

Return information about all the columns.

Specified by:

getColumnInfo in interface ResultDescription

getColumnDescriptor

public ResultColumnDescriptor getColumnDescriptor(int position)

position is 1-based.

Specified by:

getColumnDescriptor in interface ResultDescription

Parameters:

position - The oridinal position of a column in the ResultSet.

Returns:

A ResultColumnDescriptor describing the column in the ResultSet.

See Also:

ResultDescription.getColumnDescriptor(int)

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.

Specified by:

truncateColumns in interface ResultDescription

Parameters:

truncateFrom - the starting column to remove

Returns:

a new ResultDescription

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Write this object out

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out - write bytes here

Throws:

java.io.IOException - thrown on error

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Read this object from a stream of stored objects.

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

in - read this.

Throws:

java.io.IOException - thrown on error

java.lang.ClassNotFoundException - thrown on error

getTypeFormatId

public int getTypeFormatId()

Get the formatID which corresponds to this class.

Specified by:

getTypeFormatId in interface TypedFormat

Returns:

the formatID of this class

toString

public java.lang.String toString()