Top Description Fields Constructors Methods
org.apache.derby.impl.sql

public Class CursorInfo

extends Object
implements Formatable
Class Inheritance
All Implemented Interfaces
org.apache.derby.iapi.services.io.Formatable, org.apache.derby.iapi.services.io.TypedFormat, java.io.Externalizable, java.io.Serializable
Imports
org.apache.derby.iapi.sql.execute.ExecCursorTableReference, org.apache.derby.shared.common.sanity.SanityManager, org.apache.derby.shared.common.util.ArrayUtil, org.apache.derby.iapi.services.io.StoredFormatIds, .Formatable, java.io.ObjectOutput, .ObjectInput, .IOException, java.util.ArrayList, .Arrays, .List
A basic holder for information about cursors for execution.

Field Summary

Modifier and TypeField and Description
pack-priv ExecCursorTableReference
targetTable

This class implements Formatable.

pack-priv List<String>
updateColumns

pack-priv int
updateMode

Constructor Summary

AccessConstructor and Description
public
CursorInfo()

Niladic constructor for Formatable

public
CursorInfo(int updateMode, ExecCursorTableReference targetTable, List<String> updateColumns)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the formatID of this class
getTypeFormatId()

Implements org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId.

Get the formatID which corresponds to this class.

public void
readExternal(ObjectInput
read this.
in)

Implements java.io.Externalizable.readExternal.

Read this object from a stream of stored objects.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public void
writeExternal(ObjectOutput
write bytes here
out)

Implements java.io.Externalizable.writeExternal.

Write this object out

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

targetTableback to summary
pack-priv ExecCursorTableReference targetTable

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.

updateColumnsback to summary
pack-priv List<String> updateColumns
updateModeback to summary
pack-priv int updateMode

Constructor Detail

CursorInfoback to summary
public CursorInfo()

Niladic constructor for Formatable

CursorInfoback to summary
public CursorInfo(int updateMode, ExecCursorTableReference targetTable, List<String> updateColumns)

Method Detail

getTypeFormatIdback to summary
public int getTypeFormatId()

Implements org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId.

Get the formatID which corresponds to this class.

Returns:int

the formatID of this class

readExternalback to summary
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Implements java.io.Externalizable.readExternal.

Read this object from a stream of stored objects.

Parameters
in:ObjectInput

read this.

Exceptions
IOException:
thrown on error
ClassNotFoundException:
thrown on error
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

writeExternalback to summary
public void writeExternal(ObjectOutput out) throws IOException

Implements java.io.Externalizable.writeExternal.

Write this object out

Parameters
out:ObjectOutput

write bytes here

Exceptions
IOException:
thrown on error