org.apache.derby.iapi.sql.dictionary
Class AliasDescriptor

java.lang.Object
  extended byorg.apache.derby.iapi.sql.dictionary.TupleDescriptor
      extended byorg.apache.derby.iapi.sql.dictionary.AliasDescriptor
All Implemented Interfaces:
Dependable, Provider, UniqueTupleDescriptor

public final class AliasDescriptor
extends TupleDescriptor
implements UniqueTupleDescriptor, Provider

This class represents an Alias Descriptor. The public methods for this class are:

  1. getUUID
  2. getJavaClassName
  3. getAliasType
  4. getNameSpace
  5. getSystemAlias
  6. getAliasId

Author:
Jerry Brenner

Field Summary
private  UUID aliasID
           
private  AliasInfo aliasInfo
           
private  java.lang.String aliasName
           
private  char aliasType
           
private  java.lang.String javaClassName
           
private  char nameSpace
           
private  UUID schemaID
           
private  java.lang.String specificName
           
private  boolean systemAlias
           
 
Fields inherited from class org.apache.derby.iapi.sql.dictionary.TupleDescriptor
COLUMN_LIST, CONGLOMERATE_LIST, CONSTRAINT_LIST, TRIGGER_LIST
 
Fields inherited from interface org.apache.derby.catalog.Dependable
ALIAS, COLUMNS_IN_TABLE, CONGLOMERATE, CONSTRAINT, DEFAULT, FILE, HEAP, INDEX, PREPARED_STATEMENT, SCHEMA, STORED_PREPARED_STATEMENT, TABLE, TRIGGER, VIEW
 
Constructor Summary
AliasDescriptor(DataDictionary dataDictionary, UUID aliasID, java.lang.String aliasName, UUID schemaID, java.lang.String javaClassName, char aliasType, char nameSpace, boolean systemAlias, AliasInfo aliasInfo, java.lang.String specificName)
          Constructor for a AliasDescriptor
 
Method Summary
 boolean equals(java.lang.Object otherObject)
          Determine if two AliasDescriptors are the same.
 AliasInfo getAliasInfo()
          Gests the AliasInfo for the alias.
 char getAliasType()
          Gets the type of the alias.
static java.lang.String getAliasType(char nameSpace)
           
 java.lang.String getClassType()
          Get the provider's type.
 DependableFinder getDependableFinder()
          Get an object which can be written to disk and which, when read from disk, will find or reconstruct this in-memory Dependable.
 java.lang.String getDescriptorName()
           
 java.lang.String getDescriptorType()
          Each descriptor must identify itself with its type; i.e index, check constraint whatever.
 java.lang.String getJavaClassName()
          Gets the java class name of the alias.
 char getNameSpace()
          Gets the name space of the alias.
 UUID getObjectID()
          Get the provider's UUID
 java.lang.String getObjectName()
          Return the name of this Provider.
 UUID getSchemaUUID()
          Gets the UUID of the schema for this method alias.
 java.lang.String getSpecificName()
          Return the specific name for this object.
 boolean getSystemAlias()
          Gets whether or not the alias is a system alias.
 UUID getUUID()
          Gets the UUID of the method alias.
 int hashCode()
          Get a hashcode for this AliasDescriptor
 java.lang.String toString()
          Convert the AliasDescriptor to a String.
 
Methods inherited from class org.apache.derby.iapi.sql.dictionary.TupleDescriptor
getColumnDependableFinder, getDataDictionary, getDependableFinder, isPersistent, setDataDictionary
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.derby.catalog.Dependable
isPersistent
 

Field Detail

aliasID

private UUID aliasID

aliasName

private java.lang.String aliasName

schemaID

private UUID schemaID

javaClassName

private java.lang.String javaClassName

aliasType

private char aliasType

nameSpace

private char nameSpace

systemAlias

private boolean systemAlias

aliasInfo

private AliasInfo aliasInfo

specificName

private java.lang.String specificName
Constructor Detail

AliasDescriptor

public AliasDescriptor(DataDictionary dataDictionary,
                       UUID aliasID,
                       java.lang.String aliasName,
                       UUID schemaID,
                       java.lang.String javaClassName,
                       char aliasType,
                       char nameSpace,
                       boolean systemAlias,
                       AliasInfo aliasInfo,
                       java.lang.String specificName)
Constructor for a AliasDescriptor

Parameters:
dataDictionary - The data dictionary that this descriptor lives in
aliasID - The UUID for this alias
aliasName - The name of the method alias
schemaID - The UUID for this alias's schema
javaClassName - The java class name of the alias
aliasType - The alias type
nameSpace - The alias name space
aliasInfo - The AliasInfo for the alias
Method Detail

getUUID

public UUID getUUID()
Gets the UUID of the method alias.

Specified by:
getUUID in interface UniqueTupleDescriptor
Returns:
The UUID String of the method alias.

getSchemaUUID

public UUID getSchemaUUID()
Gets the UUID of the schema for this method alias.

Returns:
The UUID String of the schema id.

getJavaClassName

public java.lang.String getJavaClassName()
Gets the java class name of the alias.

Returns:
The java class name of the alias.

getAliasType

public char getAliasType()
Gets the type of the alias.

Returns:
The type of the alias.

getNameSpace

public char getNameSpace()
Gets the name space of the alias.

Returns:
The name space of the alias.

getSystemAlias

public boolean getSystemAlias()
Gets whether or not the alias is a system alias.

Returns:
Whether or not the alias is a system alias.

getAliasInfo

public AliasInfo getAliasInfo()
Gests the AliasInfo for the alias.

Returns:
The AliasInfo for the alias.

toString

public java.lang.String toString()
Convert the AliasDescriptor to a String.

Returns:
A String representation of this AliasDescriptor

equals

public boolean equals(java.lang.Object otherObject)
Determine if two AliasDescriptors are the same.

Parameters:
otherObject - other descriptor
Returns:
true if they are the same, false otherwise

hashCode

public int hashCode()
Get a hashcode for this AliasDescriptor

Returns:
hashcode

getDependableFinder

public DependableFinder getDependableFinder()
Description copied from interface: Dependable
Get an object which can be written to disk and which, when read from disk, will find or reconstruct this in-memory Dependable.

Specified by:
getDependableFinder in interface Dependable
Returns:
the stored form of this provider representation
See Also:
Dependable.getDependableFinder()

getObjectName

public java.lang.String getObjectName()
Return the name of this Provider. (Useful for errors.)

Specified by:
getObjectName in interface Dependable
Returns:
String The name of this provider.

getObjectID

public UUID getObjectID()
Get the provider's UUID

Specified by:
getObjectID in interface Dependable
Returns:
String The provider's UUID

getClassType

public java.lang.String getClassType()
Get the provider's type.

Specified by:
getClassType in interface Dependable
Returns:
String The provider's type.

getDescriptorType

public java.lang.String getDescriptorType()
Description copied from class: TupleDescriptor
Each descriptor must identify itself with its type; i.e index, check constraint whatever.

Overrides:
getDescriptorType in class TupleDescriptor
See Also:
TupleDescriptor.getDescriptorType()

getAliasType

public static final java.lang.String getAliasType(char nameSpace)

getDescriptorName

public java.lang.String getDescriptorName()
Overrides:
getDescriptorName in class TupleDescriptor
See Also:
TupleDescriptor.getDescriptorName()

getSpecificName

public java.lang.String getSpecificName()
Return the specific name for this object.


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.