org.apache.derby.catalog.types
Class UserDefinedTypeIdImpl

java.lang.Object
  extended byorg.apache.derby.catalog.types.BaseTypeIdImpl
      extended byorg.apache.derby.catalog.types.UserDefinedTypeIdImpl
All Implemented Interfaces:
java.io.Externalizable, Formatable, java.io.Serializable, TypedFormat

public class UserDefinedTypeIdImpl
extends BaseTypeIdImpl

See Also:
Serialized Form

Field Summary
protected  java.lang.String className
          This class implements Formatable.
 
Fields inherited from class org.apache.derby.catalog.types.BaseTypeIdImpl
formatId, JDBCTypeId, SQLTypeName, wrapperTypeFormatId
 
Constructor Summary
UserDefinedTypeIdImpl()
          Public niladic constructor.
UserDefinedTypeIdImpl(java.lang.String className)
          Constructor for a UserDefinedTypeIdImpl.
 
Method Summary
 java.lang.String getClassName()
          Return the java class name for this type
 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.
 boolean systemBuiltIn()
          Does this type id represent a system built-in type?
 boolean userType()
          Does this type id represent a user type?
 int wrapperTypeFormatId()
          Get the format id for the wrapper type id that corresponds to this type id.
 void writeExternal(java.io.ObjectOutput out)
          Write this object to a stream of stored objects.
 
Methods inherited from class org.apache.derby.catalog.types.BaseTypeIdImpl
equals, getJDBCTypeId, getSQLTypeName, hashCode, toParsableString, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

className

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

Constructor Detail

UserDefinedTypeIdImpl

public UserDefinedTypeIdImpl()
Public niladic constructor. Needed for Formatable interface to work.


UserDefinedTypeIdImpl

public UserDefinedTypeIdImpl(java.lang.String className)
Constructor for a UserDefinedTypeIdImpl. The SQLTypeName of a UserDefinedType is assumed to be its className.

Parameters:
className - The SQL name of the type
Method Detail

getClassName

public java.lang.String getClassName()
Return the java class name for this type


systemBuiltIn

public boolean systemBuiltIn()
Does this type id represent a system built-in type?

Overrides:
systemBuiltIn in class BaseTypeIdImpl

userType

public boolean userType()
Does this type id represent a user type?

Overrides:
userType in class BaseTypeIdImpl

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
Overrides:
readExternal in class BaseTypeIdImpl
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
Overrides:
writeExternal in class BaseTypeIdImpl
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
Overrides:
getTypeFormatId in class BaseTypeIdImpl
Returns:
the formatID of this class

wrapperTypeFormatId

public int wrapperTypeFormatId()
Get the format id for the wrapper type id that corresponds to this type id.

Overrides:
wrapperTypeFormatId in class BaseTypeIdImpl

Built on Mon 2007-06-04 09:58:47+0400, from revision ???

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