FileInfoDescriptor (Apache Derby V10.14 Internals)

java.lang.Object
- org.apache.derby.iapi.sql.dictionary.TupleDescriptor
- - org.apache.derby.iapi.sql.dictionary.UniqueTupleDescriptor
  - - org.apache.derby.iapi.sql.dictionary.UniqueSQLObjectDescriptor
    - - org.apache.derby.iapi.sql.dictionary.FileInfoDescriptor

All Implemented Interfaces:

Dependable, Provider
```
public final class FileInfoDescriptor
extends UniqueSQLObjectDescriptor
implements Provider
```
A Descriptor for a file that has been stored in the database.

Field Summary

Fields
Modifier and Type	Field	Description
`private long`	`generationId`
`private UUID`	`id`	external interface to this class: public long getGenerationId();
`static int`	`JAR_FILE_TYPE`	A type tho indicate the file is a jar file
`private SchemaDescriptor`	`sd`
`private java.lang.String`	`sqlName`

Fields inherited from interface org.apache.derby.catalog.Dependable
ACTIVATION, ALIAS, COLUMNS_IN_TABLE, COLUMNS_PERMISSION, CONGLOMERATE, CONSTRAINT, DEFAULT, FILE, HEAP, INDEX, PERM, PREPARED_STATEMENT, ROLE_GRANT, ROUTINE_PERMISSION, SCHEMA, SEQUENCE, STORED_PREPARED_STATEMENT, TABLE, TABLE_PERMISSION, TRIGGER, VIEW

Constructor Summary

Constructors
Constructor	Description
`FileInfoDescriptor(DataDictionary dataDictionary, UUID id, SchemaDescriptor sd, java.lang.String sqlName, long generationId)`	Constructor for a FileInfoDescriptor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getClassType()`	Get the unique class id for the Dependable.
`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.
`long`	`getGenerationId()`	Gets the generationId for the current version of this file.
`java.lang.String`	`getName()`	Get the name of this object.
`UUID`	`getObjectID()`	Get the UUID of this Dependable OBJECT.
`java.lang.String`	`getObjectName()`	Get the name of this Dependable OBJECT.
`SchemaDescriptor`	`getSchemaDescriptor()`	Get the objects schema descriptor
`UUID`	`getUUID()`	Return the UUID for this Descriptor

Methods inherited from interface org.apache.derby.catalog.Dependable
isPersistent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class org.apache.derby.iapi.sql.dictionary.TupleDescriptor
getColumnDependableFinder, getDataDictionary, getDependableFinder, isPersistent, setDataDictionary

- Field Detail
  - JAR_FILE_TYPE
```
public static final int JAR_FILE_TYPE
```
    A type tho indicate the file is a jar file
    
    See Also:
    
    Constant Field Values
  - id
```
private final UUID id
```
    external interface to this class:
    1. public long getGenerationId();
  - sd
```
private final SchemaDescriptor sd
```
  - sqlName
```
private final java.lang.String sqlName
```
  - generationId
```
private final long generationId
```
- Constructor Detail
  - FileInfoDescriptor
```
public FileInfoDescriptor(DataDictionary dataDictionary,
                          UUID id,
                          SchemaDescriptor sd,
                          java.lang.String sqlName,
                          long generationId)
```
    Constructor for a FileInfoDescriptor.
    
    Parameters:
    
    dataDictionary - The data dictionary that this descriptor lives in
    
    id - The id for this file
    
    sd - The schema for this file.
    
    sqlName - The SQL name of this file.
    
    generationId - The generation id for the version of the file this describes.
- Method Detail
  - getSchemaDescriptor
```
public SchemaDescriptor getSchemaDescriptor()
```
    Description copied from class: UniqueSQLObjectDescriptor
    
    Get the objects schema descriptor
    
    Specified by:
    
    getSchemaDescriptor in class UniqueSQLObjectDescriptor
    
    Returns:
    
    the schema descriptor
  - getName
```
public java.lang.String getName()
```
    Description copied from class: UniqueSQLObjectDescriptor
    
    Get the name of this object. E.g. for a table descriptor, this will be the table name.
    
    Specified by:
    
    getName in class UniqueSQLObjectDescriptor
    
    Returns:
    
    the name
  - getUUID
```
public UUID getUUID()
```
    Description copied from class: UniqueTupleDescriptor
    
    Return the UUID for this Descriptor
    
    Specified by:
    
    getUUID in class UniqueTupleDescriptor
    
    Returns:
    
    the uuid
    
    See Also:
    
    UniqueTupleDescriptor.getUUID()
  - getGenerationId
```
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:
    
    the generationId for this file
  - 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:
    
    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()
  - getObjectName
```
public java.lang.String getObjectName()
```
    Description copied from interface: Dependable
    
    Get the name of this Dependable OBJECT. This is useful for diagnostic messages.
    
    Specified by:
    
    getObjectName in interface Dependable
    
    Returns:
    
    Name of Dependable OBJECT.
    
    See Also:
    
    Dependable.getObjectName()
  - getObjectID
```
public UUID getObjectID()
```
    Description copied from interface: Dependable
    
    Get the UUID of this Dependable OBJECT.
    
    Specified by:
    
    getObjectID in interface Dependable
    
    Returns:
    
    UUID of this OBJECT.
    
    See Also:
    
    Dependable.getObjectID()
  - getClassType
```
public java.lang.String getClassType()
```
    Description copied from interface: Dependable
    
    Get the unique class id for the Dependable. Every Dependable belongs to a class of Dependables.
    
    Specified by:
    
    getClassType in interface Dependable
    
    Returns:
    
    type of this Dependable.
    
    See Also:
    
    Dependable.getClassType()
  - 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()
  - getDescriptorName
```
public java.lang.String getDescriptorName()
```
    Overrides:
    
    getDescriptorName in class TupleDescriptor
    
    See Also:
    
    TupleDescriptor.getDescriptorName()

Class FileInfoDescriptor

Field Summary

Fields inherited from interface org.apache.derby.catalog.Dependable

Constructor Summary

Method Summary

Methods inherited from interface org.apache.derby.catalog.Dependable

Methods inherited from class java.lang.Object

Methods inherited from class org.apache.derby.iapi.sql.dictionary.TupleDescriptor

Field Detail

JAR_FILE_TYPE

id

sd

sqlName

generationId

Constructor Detail

FileInfoDescriptor

Method Detail

getSchemaDescriptor

getName

getUUID

getGenerationId

getDependableFinder

getObjectName

getObjectID

getClassType

getDescriptorType

getDescriptorName