Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.iapi.sql.dictionary.AliasDescriptor

Modifier and Type	Field and Description
private final UUID	aliasID
private final AliasInfo	aliasInfo
private final String	aliasName
private final char	aliasType
private final String	javaClassName
private final char	nameSpace
private final SchemaDescriptor	schemaDescriptor
private final UUID	schemaID
private final String	specificName
private final boolean	systemAlias

Access	Constructor and Description
public	AliasDescriptor(DataDictionary The data dictionary that this descriptor lives in dataDictionary, UUID The UUID for this alias aliasID, String The name of the method alias aliasName, UUID The UUID for this alias's schema schemaID, String The java class name of the alias javaClassName, char The alias type aliasType, char The alias name space nameSpace, boolean systemAlias, AliasInfo The AliasInfo for the alias aliasInfo, String specificName) Constructor for a AliasDescriptor

Method Summary

Modifier and Type	Method and Description
public void	drop(LanguageConnectionContext lcc) Drop the routine or synonym.
public boolean	Returns: true if they are the same, false otherwise equals(Object other descriptor otherObject) Overrides java.lang.Object.equals. Determine if two AliasDescriptors are the same.
public AliasInfo	Returns: The AliasInfo for the alias. getAliasInfo() Gests the AliasInfo for the alias.
public char	Returns: The type of the alias. getAliasType() Gets the type of the alias.
public static final String	getAliasType(char nameSpace)
public String	Returns: String The provider's type. getClassType() Implements org.apache.derby.catalog.Dependable.getClassType. Get the provider's type.
public DependableFinder	Returns: the stored form of this provider representation getDependableFinder() Implements org.apache.derby.catalog.Dependable.getDependableFinder. Get an object which can be written to disk and which, when read from disk, will find or reconstruct this in-memory Dependable.
public String	getDescriptorName() Overrides org.apache.derby.iapi.sql.dictionary.TupleDescriptor.getDescriptorName.
public String	getDescriptorType() Overrides org.apache.derby.iapi.sql.dictionary.TupleDescriptor.getDescriptorType. Each descriptor must identify itself with its type; i.e index, check constraint whatever.
public String	Returns: The java class name of the alias. getJavaClassName() Gets the java class name of the alias.
public final String	Returns: A String containing the name of the statement. getName() Implements abstract org.apache.derby.iapi.sql.dictionary.UniqueSQLObjectDescriptor.getName. Gets the name of the alias.
public char	Returns: The name space of the alias. getNameSpace() Gets the name space of the alias.
public UUID	Returns: String The provider's UUID getObjectID() Implements org.apache.derby.catalog.Dependable.getObjectID. Get the provider's UUID
public String	Returns: String The name of this provider. getObjectName() Implements org.apache.derby.catalog.Dependable.getObjectName. Return the name of this Provider.
public String	getObjectTypeName() Implements abstract org.apache.derby.iapi.sql.dictionary.PrivilegedSQLObject.getObjectTypeName. Get the type of the object for storage in SYS.SYSPERMS
public String	Returns: A String containing the name of the table. getQualifiedName() Gets the full, qualified name of the alias.
public final SchemaDescriptor	Returns: SchemaDescriptor The SchemaDescriptor. getSchemaDescriptor() Implements abstract org.apache.derby.iapi.sql.dictionary.UniqueSQLObjectDescriptor.getSchemaDescriptor. Gets the SchemaDescriptor for this alias.
public String	Returns: A String containing the name of the schema that the alias lives in. getSchemaName() Gets the name of the schema that the alias lives in.
public UUID	Returns: The UUID String of the schema id. getSchemaUUID() Gets the UUID of the schema for this method alias.
public String	getSpecificName() Return the specific name for this object.
public boolean	Returns: Whether or not the alias is a system alias. getSystemAlias() Gets whether or not the alias is a system alias.
public UUID	Returns: The UUID String of the method alias. getUUID() Implements abstract org.apache.derby.iapi.sql.dictionary.UniqueTupleDescriptor.getUUID. Gets the UUID of the method alias.
public int	Returns: hashcode hashCode() Overrides java.lang.Object.hashCode. Get a hashcode for this AliasDescriptor
public boolean	isPersistent() Overrides org.apache.derby.iapi.sql.dictionary.TupleDescriptor.isPersistent. Implements org.apache.derby.catalog.Dependable.isPersistent. Functions are persistent unless they are in the SYSFUN schema.
public boolean	isTableFunction() Report whether this descriptor describes a Table Function.
public synchronized boolean	Returns: true if the dependent is currently valid isValid() Implements org.apache.derby.iapi.sql.depend.Dependent.isValid. Check that all of the dependent's dependencies are valid.
public void	makeInvalid(int The action causing the invalidation action, LanguageConnectionContext The LanguageConnectionContext lcc) Implements org.apache.derby.iapi.sql.depend.Dependent.makeInvalid. Mark the dependent as invalid (due to at least one of its dependencies being invalid).
public void	prepareToInvalidate(Provider the provider p, int The action causing the invalidation action, LanguageConnectionContext The LanguageConnectionContext lcc) Implements org.apache.derby.iapi.sql.depend.Dependent.prepareToInvalidate. Prepare to mark the dependent as invalid (due to at least one of its dependencies being invalid).
public String	Returns: A String representation of this AliasDescriptor toString() Overrides java.lang.Object.toString. Convert the AliasDescriptor to a String.

aliasID	back to summary
private final UUID aliasID

aliasInfo	back to summary
private final AliasInfo aliasInfo

aliasName	back to summary
private final String aliasName

aliasType	back to summary
private final char aliasType

javaClassName	back to summary
private final String javaClassName

nameSpace	back to summary
private final char nameSpace

schemaDescriptor	back to summary
private final SchemaDescriptor schemaDescriptor

schemaID	back to summary
private final UUID schemaID

specificName	back to summary
private final String specificName

systemAlias	back to summary
private final boolean systemAlias

AliasDescriptor	back to summary
public AliasDescriptor(DataDictionary dataDictionary, UUID aliasID, String aliasName, UUID schemaID, String javaClassName, char aliasType, char nameSpace, boolean systemAlias, AliasInfo aliasInfo, String specificName) throws StandardException Constructor for a AliasDescriptor Parameters dataDictionary:DataDictionary The data dictionary that this descriptor lives in aliasID:UUID The UUID for this alias aliasName:String The name of the method alias schemaID:UUID The UUID for this alias's schema javaClassName:String The java class name of the alias aliasType:char The alias type nameSpace:char The alias name space aliasInfo:AliasInfo The AliasInfo for the alias

Method Detail

drop	back to summary
public void drop(LanguageConnectionContext lcc) throws StandardException Drop the routine or synonym. For a routine its permission descriptors will be dropped as well. For a synonym its TableDescriptor will be dropped as well.

equals	back to summary
public boolean equals(Object otherObject) Overrides java.lang.Object.equals. Determine if two AliasDescriptors are the same. Parameters otherObject:Object other descriptor Returns:boolean true if they are the same, false otherwise

equals

back to summary

public boolean equals(Object otherObject)

Overrides java.lang.Object.equals.

Determine if two AliasDescriptors are the same.

Parameters

otherObject:Object: other descriptor

Returns:boolean

true if they are the same, false otherwise

getAliasInfo	back to summary
public AliasInfo getAliasInfo() Gests the AliasInfo for the alias. Returns:AliasInfo The AliasInfo for the alias.

getAliasInfo

back to summary

public AliasInfo getAliasInfo()

Gests the AliasInfo for the alias.

Returns:AliasInfo: The AliasInfo for the alias.

getAliasType	back to summary
public char getAliasType() Gets the type of the alias. Returns:char The type of the alias.

getAliasType

back to summary

public char getAliasType()

Gets the type of the alias.

Returns:char: The type of the alias.

getAliasType	back to summary
public static final String getAliasType(char nameSpace)

getClassType	back to summary
public String getClassType() Implements org.apache.derby.catalog.Dependable.getClassType. Get the provider's type. Returns:String String The provider's type.

getClassType

back to summary

public String getClassType()

Implements org.apache.derby.catalog.Dependable.getClassType.

Get the provider's type.

Returns:String: String The provider's type.

getDependableFinder back to summary

getDependableFinder	back to summary
public DependableFinder getDependableFinder() Implements org.apache.derby.catalog.Dependable.getDependableFinder. Doc from org.apache.derby.catalog.Dependable.getDependableFinder. Get an object which can be written to disk and which, when read from disk, will find or reconstruct this in-memory Dependable. Returns:DependableFinder the stored form of this provider representation See Also `Dependable#getDependableFinder`

public DependableFinder getDependableFinder()

Implements org.apache.derby.catalog.Dependable.getDependableFinder.

Doc from org.apache.derby.catalog.Dependable.getDependableFinder.

Get an object which can be written to disk and which, when read from disk, will find or reconstruct this in-memory Dependable.

Returns:DependableFinder: the stored form of this provider representation
See Also: Dependable#getDependableFinder

getDescriptorName back to summary

getDescriptorName	back to summary
public String getDescriptorName() Overrides org.apache.derby.iapi.sql.dictionary.TupleDescriptor.getDescriptorName. See Also `TupleDescriptor#getDescriptorName`

public String getDescriptorName()

Overrides org.apache.derby.iapi.sql.dictionary.TupleDescriptor.getDescriptorName.

See Also: TupleDescriptor#getDescriptorName

getDescriptorType back to summary

getDescriptorType	back to summary
public String getDescriptorType() Overrides org.apache.derby.iapi.sql.dictionary.TupleDescriptor.getDescriptorType. Doc from org.apache.derby.iapi.sql.dictionary.TupleDescriptor.getDescriptorType. Each descriptor must identify itself with its type; i.e index, check constraint whatever. See Also `TupleDescriptor#getDescriptorType`

public String getDescriptorType()

Overrides org.apache.derby.iapi.sql.dictionary.TupleDescriptor.getDescriptorType.

Doc from org.apache.derby.iapi.sql.dictionary.TupleDescriptor.getDescriptorType.

Each descriptor must identify itself with its type; i.e index, check constraint whatever.

See Also: TupleDescriptor#getDescriptorType

getJavaClassName	back to summary
public String getJavaClassName() Gets the java class name of the alias. Returns:String The java class name of the alias.

getJavaClassName

back to summary

public String getJavaClassName()

Gets the java class name of the alias.

Returns:String: The java class name of the alias.

getName	back to summary
public final String getName() Implements abstract org.apache.derby.iapi.sql.dictionary.UniqueSQLObjectDescriptor.getName. Gets the name of the alias. Returns:String A String containing the name of the statement.

getName

back to summary

public final String getName()

Implements abstract org.apache.derby.iapi.sql.dictionary.UniqueSQLObjectDescriptor.getName.

Gets the name of the alias.

Returns:String: A String containing the name of the statement.

getNameSpace	back to summary
public char getNameSpace() Gets the name space of the alias. Returns:char The name space of the alias.

getNameSpace

back to summary

public char getNameSpace()

Gets the name space of the alias.

Returns:char: The name space of the alias.

getObjectID	back to summary
public UUID getObjectID() Implements org.apache.derby.catalog.Dependable.getObjectID. Get the provider's UUID Returns:UUID String The provider's UUID

getObjectID

back to summary

public UUID getObjectID()

Implements org.apache.derby.catalog.Dependable.getObjectID.

Get the provider's UUID

Returns:UUID: String The provider's UUID

getObjectName	back to summary
public String getObjectName() Implements org.apache.derby.catalog.Dependable.getObjectName. Return the name of this Provider. (Useful for errors.) Returns:String String The name of this provider.

getObjectName

back to summary

public String getObjectName()

Implements org.apache.derby.catalog.Dependable.getObjectName.

Return the name of this Provider. (Useful for errors.)

Returns:String: String The name of this provider.

getObjectTypeName back to summary

getObjectTypeName	back to summary
public String getObjectTypeName() Implements abstract org.apache.derby.iapi.sql.dictionary.PrivilegedSQLObject.getObjectTypeName. Doc from org.apache.derby.iapi.sql.dictionary.PrivilegedSQLObject.getObjectTypeName. Get the type of the object for storage in SYS.SYSPERMS See Also `PrivilegedSQLObject#getObjectTypeName`

public String getObjectTypeName()

Implements abstract org.apache.derby.iapi.sql.dictionary.PrivilegedSQLObject.getObjectTypeName.

Doc from org.apache.derby.iapi.sql.dictionary.PrivilegedSQLObject.getObjectTypeName.

Get the type of the object for storage in SYS.SYSPERMS

See Also: PrivilegedSQLObject#getObjectTypeName

getQualifiedName	back to summary
public String getQualifiedName() Gets the full, qualified name of the alias. Returns:String A String containing the name of the table.

getQualifiedName

back to summary

public String getQualifiedName()

Gets the full, qualified name of the alias.

Returns:String: A String containing the name of the table.

getSchemaDescriptor	back to summary
public final SchemaDescriptor getSchemaDescriptor() Implements abstract org.apache.derby.iapi.sql.dictionary.UniqueSQLObjectDescriptor.getSchemaDescriptor. Gets the SchemaDescriptor for this alias. Returns:SchemaDescriptor SchemaDescriptor The SchemaDescriptor.

getSchemaDescriptor

back to summary

public final SchemaDescriptor getSchemaDescriptor()

Implements abstract org.apache.derby.iapi.sql.dictionary.UniqueSQLObjectDescriptor.getSchemaDescriptor.

Gets the SchemaDescriptor for this alias.

Returns:SchemaDescriptor: SchemaDescriptor The SchemaDescriptor.

getSchemaName	back to summary
public String getSchemaName() Gets the name of the schema that the alias lives in. Returns:String A String containing the name of the schema that the alias lives in.

getSchemaName

back to summary

public String getSchemaName()

Gets the name of the schema that the alias lives in.

Returns:String: A String containing the name of the schema that the alias lives in.

getSchemaUUID	back to summary
public UUID getSchemaUUID() Gets the UUID of the schema for this method alias. Returns:UUID The UUID String of the schema id.

getSchemaUUID

back to summary

public UUID getSchemaUUID()

Gets the UUID of the schema for this method alias.

Returns:UUID: The UUID String of the schema id.

getSpecificName	back to summary
public String getSpecificName() Return the specific name for this object.

getSystemAlias	back to summary
public boolean getSystemAlias() Gets whether or not the alias is a system alias. Returns:boolean Whether or not the alias is a system alias.

getSystemAlias

back to summary

public boolean getSystemAlias()

Gets whether or not the alias is a system alias.

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

getUUID	back to summary
public UUID getUUID() Implements abstract org.apache.derby.iapi.sql.dictionary.UniqueTupleDescriptor.getUUID. Gets the UUID of the method alias. Returns:UUID The UUID String of the method alias.

getUUID

back to summary

public UUID getUUID()

Implements abstract org.apache.derby.iapi.sql.dictionary.UniqueTupleDescriptor.getUUID.

Gets the UUID of the method alias.

Returns:UUID: The UUID String of the method alias.

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Get a hashcode for this AliasDescriptor Returns:int hashcode

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Get a hashcode for this AliasDescriptor

Returns:int: hashcode

isPersistent	back to summary
public boolean isPersistent() Overrides org.apache.derby.iapi.sql.dictionary.TupleDescriptor.isPersistent. Implements org.apache.derby.catalog.Dependable.isPersistent. Functions are persistent unless they are in the SYSFUN schema. Returns:boolean Doc from org.apache.derby.catalog.Dependable.isPersistent. true if this Dependable is persistent.

isPersistent

back to summary

public boolean isPersistent()

Overrides org.apache.derby.iapi.sql.dictionary.TupleDescriptor.isPersistent.

Implements org.apache.derby.catalog.Dependable.isPersistent.

Functions are persistent unless they are in the SYSFUN schema.

Returns:boolean

Doc from org.apache.derby.catalog.Dependable.isPersistent.

true if this Dependable is persistent.

isTableFunction	back to summary
public boolean isTableFunction() Report whether this descriptor describes a Table Function.

isValid	back to summary
public synchronized boolean isValid() Implements org.apache.derby.iapi.sql.depend.Dependent.isValid. Check that all of the dependent's dependencies are valid. Returns:boolean true if the dependent is currently valid

isValid

back to summary

public synchronized boolean isValid()

Implements org.apache.derby.iapi.sql.depend.Dependent.isValid.

Check that all of the dependent's dependencies are valid.

Returns:boolean: true if the dependent is currently valid

makeInvalid	back to summary
public void makeInvalid(int action, LanguageConnectionContext lcc) throws StandardException Implements org.apache.derby.iapi.sql.depend.Dependent.makeInvalid. Mark the dependent as invalid (due to at least one of its dependencies being invalid). Always an error for an alias -- should never have gotten here. Parameters action:int The action causing the invalidation lcc:LanguageConnectionContext Doc from org.apache.derby.iapi.sql.depend.Dependent.makeInvalid. The LanguageConnectionContext Exceptions StandardException: thrown if called in sanity mode

makeInvalid

back to summary

public void makeInvalid(int action, LanguageConnectionContext lcc) throws StandardException

Implements org.apache.derby.iapi.sql.depend.Dependent.makeInvalid.

Mark the dependent as invalid (due to at least one of its dependencies being invalid). Always an error for an alias -- should never have gotten here.

Parameters

action:int

The action causing the invalidation

lcc:LanguageConnectionContext

Doc from org.apache.derby.iapi.sql.depend.Dependent.makeInvalid.

The LanguageConnectionContext

Exceptions

StandardException:: thrown if called in sanity mode

prepareToInvalidate	back to summary
public void prepareToInvalidate(Provider p, int action, LanguageConnectionContext lcc) throws StandardException Implements org.apache.derby.iapi.sql.depend.Dependent.prepareToInvalidate. Prepare to mark the dependent as invalid (due to at least one of its dependencies being invalid). Parameters p:Provider the provider action:int The action causing the invalidation lcc:LanguageConnectionContext Doc from org.apache.derby.iapi.sql.depend.Dependent.prepareToInvalidate. The LanguageConnectionContext Exceptions StandardException: thrown if unable to make it invalid

prepareToInvalidate

back to summary

public void prepareToInvalidate(Provider p, int action, LanguageConnectionContext lcc) throws StandardException

Implements org.apache.derby.iapi.sql.depend.Dependent.prepareToInvalidate.

Prepare to mark the dependent as invalid (due to at least one of its dependencies being invalid).

Parameters

p:Provider

the provider

action:int

The action causing the invalidation

lcc:LanguageConnectionContext

Doc from org.apache.derby.iapi.sql.depend.Dependent.prepareToInvalidate.

The LanguageConnectionContext

Exceptions

StandardException:: thrown if unable to make it invalid

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Convert the AliasDescriptor to a String. Returns:String A String representation of this AliasDescriptor

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Convert the AliasDescriptor to a String.

Returns:String: A String representation of this AliasDescriptor

public final Class AliasDescriptor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail