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

public Class CursorTableReference

extends Object
implements ExecCursorTableReference, 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, org.apache.derby.iapi.sql.execute.ExecCursorTableReference
Imports
org.apache.derby.iapi.sql.execute.ExecCursorTableReference, org.apache.derby.shared.common.sanity.SanityManager, org.apache.derby.iapi.services.io.StoredFormatIds, .FormatIdUtil, .Formatable, java.io.ObjectOutput, .ObjectInput, .IOException

Field Summary

Modifier and TypeField and Description
private String
private String
exposedName

This class implements Formatable.

private String

Constructor Summary

AccessConstructor and Description
public
CursorTableReference()

Niladic constructor for Formatable

public
CursorTableReference(String exposedName, String baseName, String schemaName)

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the base name
getBaseName
()

Implements org.apache.derby.iapi.sql.execute.ExecCursorTableReference.getBaseName.

Return the base name of the table

public String

Returns:

the base name
getExposedName
()

Implements org.apache.derby.iapi.sql.execute.ExecCursorTableReference.getExposedName.

Return the exposed name of the table.

public String

Returns:

the schema name
getSchemaName
()

Implements org.apache.derby.iapi.sql.execute.ExecCursorTableReference.getSchemaName.

Return the schema for the table.

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

baseNameback to summary
private String baseName
exposedNameback to summary
private String exposedName

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.

schemaNameback to summary
private String schemaName

Constructor Detail

CursorTableReferenceback to summary
public CursorTableReference()

Niladic constructor for Formatable

CursorTableReferenceback to summary
public CursorTableReference(String exposedName, String baseName, String schemaName)

Method Detail

getBaseNameback to summary
public String getBaseName()

Implements org.apache.derby.iapi.sql.execute.ExecCursorTableReference.getBaseName.

Return the base name of the table

Returns:String

the base name

getExposedNameback to summary
public String getExposedName()

Implements org.apache.derby.iapi.sql.execute.ExecCursorTableReference.getExposedName.

Return the exposed name of the table. Exposed name is another term for correlation name. If there is no correlation, this will return the base name.

Returns:String

the base name

getSchemaNameback to summary
public String getSchemaName()

Implements org.apache.derby.iapi.sql.execute.ExecCursorTableReference.getSchemaName.

Return the schema for the table.

Returns:String

the schema name

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