org.apache.derby.impl.sql
Class CursorTableReference

java.lang.Object
  extended byorg.apache.derby.impl.sql.CursorTableReference
All Implemented Interfaces:
ExecCursorTableReference, java.io.Externalizable, Formatable, java.io.Serializable, TypedFormat

public class CursorTableReference
extends java.lang.Object
implements ExecCursorTableReference, Formatable

Author:
jamie
See Also:
Serialized Form

Field Summary
private  java.lang.String baseName
           
private  java.lang.String exposedName
          This class implements Formatable.
private  java.lang.String schemaName
           
 
Constructor Summary
CursorTableReference()
          Niladic constructor for Formatable
CursorTableReference(java.lang.String exposedName, java.lang.String baseName, java.lang.String schemaName)
           
 
Method Summary
 java.lang.String getBaseName()
          Return the base name of the table
 java.lang.String getExposedName()
          Return the exposed name of the table.
 java.lang.String getSchemaName()
          Return the schema for the table.
 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()
           
 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

exposedName

private java.lang.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.


baseName

private java.lang.String baseName

schemaName

private java.lang.String schemaName
Constructor Detail

CursorTableReference

public CursorTableReference()
Niladic constructor for Formatable


CursorTableReference

public CursorTableReference(java.lang.String exposedName,
                            java.lang.String baseName,
                            java.lang.String schemaName)
Method Detail

getBaseName

public java.lang.String getBaseName()
Return the base name of the table

Specified by:
getBaseName in interface ExecCursorTableReference
Returns:
the base name

getExposedName

public java.lang.String 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.

Specified by:
getExposedName in interface ExecCursorTableReference
Returns:
the base name

getSchemaName

public java.lang.String getSchemaName()
Return the schema for the table.

Specified by:
getSchemaName in interface ExecCursorTableReference
Returns:
the schema name

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()

Built on Tue 2006-10-10 19:23:47+0200, from revision exported

Apache Derby V10.1 Engine Documentation - Copyright © 1997,2005 The Apache Software Foundation or its licensors, as applicable.