Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> derby >> iapi >> sql >> [ dictionary overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

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

java.lang.Object
  org.apache.derby.iapi.sql.dictionary.TupleDescriptor
      org.apache.derby.iapi.sql.dictionary.ConglomerateDescriptor

All Implemented Interfaces:

org.apache.derby.catalog.Dependable, org.apache.derby.iapi.sql.depend.Provider, UniqueTupleDescriptor

---

public class ConglomerateDescriptor

extends TupleDescriptor

implements UniqueTupleDescriptor, org.apache.derby.iapi.sql.depend.Provider

The ConglomerateDescriptor class is used to get information about conglomerates for the purpose of optimization. NOTE: The language module does not have to know much about conglomerates with this architecture. To get the cost of using a conglomerate, all it has to do is pass the ConglomerateDescriptor to the access methods, along with the predicate. What the access methods need from a ConglomerateDescriptor remains to be seen.

Version:

0.1

---

Field Summary
(package private)  java.lang.String[]	columnNames
(package private)  long	conglomerateNumber
(package private)  boolean	forConstraint
(package private)  boolean	indexable
(package private)  IndexRowGenerator	indexRowGenerator
(package private)  java.lang.String	name
(package private)  org.apache.derby.catalog.UUID	schemaID
(package private)  org.apache.derby.catalog.UUID	tableID
(package private)  org.apache.derby.catalog.UUID	uuid

 

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
(package private)	ConglomerateDescriptor(DataDictionary dataDictionary, long conglomerateNumber, java.lang.String name, boolean indexable, IndexRowGenerator indexRowGenerator, boolean forConstraint, org.apache.derby.catalog.UUID uuid, org.apache.derby.catalog.UUID tableID, org.apache.derby.catalog.UUID schemaID)           Constructor for a conglomerate descriptor.

 

Method Summary
java.lang.String	getClassType()           Get the provider's type.
java.lang.String[]	getColumnNames()           Get the column names for this conglomerate descriptor.
java.lang.String	getConglomerateName()           Gets the name of the conglomerate.
long	getConglomerateNumber()           Gets the number for the conglomerate.
org.apache.derby.catalog.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.
IndexRowGenerator	getIndexDescriptor()           Gets the index row generator for this conglomerate, null if the conglomerate is not an index.
org.apache.derby.catalog.UUID	getObjectID()           Get the provider's UUID
java.lang.String	getObjectName()           Return the name of this Provider.
org.apache.derby.catalog.UUID	getSchemaID()           Gets the UUID for the schema that the conglomerate belongs to.
org.apache.derby.catalog.UUID	getTableID()           Gets the UUID for the table that the conglomerate belongs to.
org.apache.derby.catalog.UUID	getUUID()           Gets the UUID String for the conglomerate.
boolean	isConstraint()           Tells whether the conglomerate is an index backing up a constraint.
boolean	isIndex()           Tells whether the conglomerate can be used as an index.
void	setColumnNames(java.lang.String[] columnNames)           Set the column names for this conglomerate descriptor.
void	setConglomerateName(java.lang.String newName)           Set the name of the conglomerate.
void	setConglomerateNumber(long conglomerateNumber)           Set the conglomerate number.
java.lang.String	toString()           Convert the conglomerate descriptor 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

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

isPersistent

 

Field Detail

conglomerateNumber

long conglomerateNumber

---

name

java.lang.String name

---

columnNames

java.lang.String[] columnNames

---

indexable

boolean indexable

---

forConstraint

boolean forConstraint

---

indexRowGenerator

IndexRowGenerator indexRowGenerator

---

uuid

org.apache.derby.catalog.UUID uuid

---

tableID

org.apache.derby.catalog.UUID tableID

---

schemaID

org.apache.derby.catalog.UUID schemaID

Constructor Detail

ConglomerateDescriptor

ConglomerateDescriptor(DataDictionary dataDictionary,
                       long conglomerateNumber,
                       java.lang.String name,
                       boolean indexable,
                       IndexRowGenerator indexRowGenerator,
                       boolean forConstraint,
                       org.apache.derby.catalog.UUID uuid,
                       org.apache.derby.catalog.UUID tableID,
                       org.apache.derby.catalog.UUID schemaID)

Constructor for a conglomerate descriptor.

Method Detail

getConglomerateNumber

public long getConglomerateNumber()

Gets the number for the conglomerate.

---

setConglomerateNumber

public void setConglomerateNumber(long conglomerateNumber)

Set the conglomerate number. This is useful when swapping conglomerates, like for bulkInsert.

---

getUUID

public org.apache.derby.catalog.UUID getUUID()

Gets the UUID String for the conglomerate.

Specified by:

getUUID in interface UniqueTupleDescriptor

---

getTableID

public org.apache.derby.catalog.UUID getTableID()

Gets the UUID for the table that the conglomerate belongs to.

---

getSchemaID

public org.apache.derby.catalog.UUID getSchemaID()

Gets the UUID for the schema that the conglomerate belongs to.

---

isIndex

public boolean isIndex()

Tells whether the conglomerate can be used as an index.

---

isConstraint

public boolean isConstraint()

Tells whether the conglomerate is an index backing up a constraint.

---

getConglomerateName

public java.lang.String getConglomerateName()

Gets the name of the conglomerate. For heaps, this is null. For indexes, it is the index name.

---

setConglomerateName

public void setConglomerateName(java.lang.String newName)

Set the name of the conglomerate. Used only by rename index.

---

getIndexDescriptor

public IndexRowGenerator getIndexDescriptor()

Gets the index row generator for this conglomerate, null if the conglomerate is not an index.

---

setColumnNames

public void setColumnNames(java.lang.String[] columnNames)

Set the column names for this conglomerate descriptor. This is useful for tracing the optimizer.

---

getColumnNames

public java.lang.String[] getColumnNames()

Get the column names for this conglomerate descriptor. This is useful for tracing the optimizer.

---

getDependableFinder

public org.apache.derby.catalog.DependableFinder getDependableFinder()

Description copied from interface: org.apache.derby.catalog.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 org.apache.derby.catalog.Dependable

---

getObjectName

public java.lang.String getObjectName()

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

Specified by:

getObjectName in interface org.apache.derby.catalog.Dependable

---

getObjectID

public org.apache.derby.catalog.UUID getObjectID()

Get the provider's UUID

Specified by:

getObjectID in interface org.apache.derby.catalog.Dependable

---

getClassType

public java.lang.String getClassType()

Get the provider's type.

Specified by:

getClassType in interface org.apache.derby.catalog.Dependable

---

toString

public java.lang.String toString()

Convert the conglomerate descriptor to a String

---

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

---

getDescriptorName

public java.lang.String getDescriptorName()

Overrides:

getDescriptorName in class TupleDescriptor

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> derby >> iapi >> sql >> [ dictionary overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---