Top Description Fields Constructors Methods
org.apache.derby.iapi.sql.dictionary

public final Class FileInfoDescriptor

extends UniqueSQLObjectDescriptor
implements Provider
Class Inheritance
All Implemented Interfaces
org.apache.derby.iapi.sql.depend.Provider, org.apache.derby.catalog.Dependable
Imports
org.apache.derby.shared.common.error.StandardException, org.apache.derby.iapi.sql.depend.Provider, org.apache.derby.catalog.UUID, .DependableFinder, .Dependable, org.apache.derby.shared.common.reference.SQLState, org.apache.derby.shared.common.sanity.SanityManager, org.apache.derby.iapi.sql.StatementType, org.apache.derby.iapi.services.io.StoredFormatIds
A Descriptor for a file that has been stored in the database.

Field Summary

Modifier and TypeField and Description
private final long
generationId

private final UUID
id

external interface to this class:

  1. public long getGenerationId();
public static final int
JAR_FILE_TYPE

A type tho indicate the file is a jar file

private final SchemaDescriptor
sd

private final String
sqlName

Constructor Summary

AccessConstructor and Description
public
FileInfoDescriptor(DataDictionary
The data dictionary that this descriptor lives in
dataDictionary, UUID
The id for this file
id, SchemaDescriptor
The schema for this file.
sd, String
The SQL name of this file.
sqlName, long
The generation id for the version of the file this describes.
generationId)

Constructor for a FileInfoDescriptor.

Method Summary

Modifier and TypeMethod and Description
public String
getClassType()

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

Get the unique class id for the Dependable.

public DependableFinder
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 long

Returns:

the generationId for this file
getGenerationId()

Gets the generationId for the current version of this file.

public String
getName()

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

Get the name of this object.

public UUID
getObjectID()

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

Get the UUID of this Dependable OBJECT.

public String
getObjectName()

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

Get the name of this Dependable OBJECT.

public SchemaDescriptor
getSchemaDescriptor()

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

Get the objects schema descriptor

public UUID
getUUID()

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

Return the UUID for this Descriptor

Field Detail

generationIdback to summary
private final long generationId
idback to summary
private final UUID id

external interface to this class:

  1. public long getGenerationId();
JAR_FILE_TYPEback to summary
public static final int JAR_FILE_TYPE

A type tho indicate the file is a jar file

sdback to summary
private final SchemaDescriptor sd
sqlNameback to summary
private final String sqlName

Constructor Detail

FileInfoDescriptorback to summary
public FileInfoDescriptor(DataDictionary dataDictionary, UUID id, SchemaDescriptor sd, String sqlName, long generationId)

Constructor for a FileInfoDescriptor.

Parameters
dataDictionary:DataDictionary

The data dictionary that this descriptor lives in

id:UUID

The id for this file

sd:SchemaDescriptor

The schema for this file.

sqlName:String

The SQL name of this file.

generationId:long

The generation id for the version of the file this describes.

Method Detail

getClassTypeback to summary
public String getClassType()

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

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

Get the unique class id for the Dependable. Every Dependable belongs to a class of Dependables.

Returns:String

type of this Dependable.

See Also
Dependable#getClassType
getDependableFinderback 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

A Finder object that can be written to disk if this is a Persistent Dependable. Null if this is not a persistent dependable.

See Also
Dependable#getDependableFinder
getDescriptorNameback to summary
public String getDescriptorName()

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

See Also
TupleDescriptor#getDescriptorName
getDescriptorTypeback 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
getGenerationIdback to summary
public long getGenerationId()

Gets the generationId for the current version of this file. The triple (schemaName,SQLName,generationId) are unique for the life of this database.

Returns:long

the generationId for this file

getNameback to summary
public String getName()

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

Doc from org.apache.derby.iapi.sql.dictionary.UniqueSQLObjectDescriptor.getName.

Get the name of this object. E.g. for a table descriptor, this will be the table name.

Returns:String

the name

getObjectIDback to summary
public UUID getObjectID()

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

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

Get the UUID of this Dependable OBJECT.

Returns:UUID

UUID of this OBJECT.

See Also
Dependable#getObjectID
getObjectNameback to summary
public String getObjectName()

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

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

Get the name of this Dependable OBJECT. This is useful for diagnostic messages.

Returns:String

Name of Dependable OBJECT.

See Also
Dependable#getObjectName
getSchemaDescriptorback to summary
public SchemaDescriptor getSchemaDescriptor()

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

Doc from org.apache.derby.iapi.sql.dictionary.UniqueSQLObjectDescriptor.getSchemaDescriptor.

Get the objects schema descriptor

Returns:SchemaDescriptor

the schema descriptor

getUUIDback to summary
public UUID getUUID()

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

Doc from org.apache.derby.iapi.sql.dictionary.UniqueTupleDescriptor.getUUID.

Return the UUID for this Descriptor

Returns:UUID

the uuid

See Also
UniqueTupleDescriptor#getUUID