org.apache.derby.catalog.types
Class UDTAliasInfo

java.lang.Object
  extended by org.apache.derby.catalog.types.UDTAliasInfo
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable, AliasInfo, Formatable, TypedFormat

public class UDTAliasInfo
extends java.lang.Object
implements AliasInfo, Formatable

Describe an A (Abstract Data Type) alias. For the first release of USer Defined Types, this is a vacuous object. Future revs may add real information to this object. The UDTAliasInfo maintains a version stamp so that it can evolve its persistent form over time.

See Also:
AliasInfo, Serialized Form

Field Summary
private static int FIRST_VERSION
           
 
Fields inherited from interface org.apache.derby.catalog.AliasInfo
ALIAS_NAME_SPACE_FUNCTION_AS_CHAR, ALIAS_NAME_SPACE_FUNCTION_AS_STRING, ALIAS_NAME_SPACE_PROCEDURE_AS_CHAR, ALIAS_NAME_SPACE_PROCEDURE_AS_STRING, ALIAS_NAME_SPACE_SYNONYM_AS_CHAR, ALIAS_NAME_SPACE_SYNONYM_AS_STRING, ALIAS_NAME_SPACE_UDT_AS_CHAR, ALIAS_NAME_SPACE_UDT_AS_STRING, ALIAS_TYPE_FUNCTION_AS_CHAR, ALIAS_TYPE_FUNCTION_AS_STRING, ALIAS_TYPE_PROCEDURE_AS_CHAR, ALIAS_TYPE_PROCEDURE_AS_STRING, ALIAS_TYPE_SYNONYM_AS_CHAR, ALIAS_TYPE_SYNONYM_AS_STRING, ALIAS_TYPE_UDT_AS_CHAR, ALIAS_TYPE_UDT_AS_STRING
 
Constructor Summary
UDTAliasInfo()
           
 
Method Summary
 java.lang.String getMethodName()
          Get the name of the static method that the alias represents at the source database.
 int getTypeFormatId()
          Get the formatID which corresponds to this class.
 boolean isTableFunction()
          Return true if this alias is a Table Function.
 void readExternal(java.io.ObjectInput in)
          Read this object from a stream of stored objects.
 java.lang.String toString()
          This is used by dblook to reconstruct the UDT-specific parts of the ddl needed to recreate this alias.
 void writeExternal(java.io.ObjectOutput out)
          Write this object to a stream of stored objects.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

FIRST_VERSION

private static final int FIRST_VERSION
See Also:
Constant Field Values
Constructor Detail

UDTAliasInfo

public UDTAliasInfo()
Method Detail

isTableFunction

public boolean isTableFunction()
Description copied from interface: AliasInfo
Return true if this alias is a Table Function.

Specified by:
isTableFunction in interface AliasInfo

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

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Write this object to a stream of stored objects.

Specified by:
writeExternal in interface java.io.Externalizable
Parameters:
out - write bytes here.
Throws:
java.io.IOException - 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()
This is used by dblook to reconstruct the UDT-specific parts of the ddl needed to recreate this alias.

Overrides:
toString in class java.lang.Object

getMethodName

public java.lang.String getMethodName()
Description copied from interface: AliasInfo
Get the name of the static method that the alias represents at the source database. (Only meaningful for method aliases )

Specified by:
getMethodName in interface AliasInfo
Returns:
The name of the static method that the alias represents at the source database.

Built on Thu 2012-03-29 21:53:33+0000, from revision ???

Apache Derby V10.6 Internals - Copyright © 2004,2007 The Apache Software Foundation. All Rights Reserved.