org.apache.derby.iapi.store.access.conglomerate

Interface ConglomerateFactory

All Superinterfaces:

MethodFactory, ModuleSupportable

All Known Implementing Classes:

B2IFactory, HeapConglomerateFactory

public interface ConglomerateFactory
extends MethodFactory

The factory interface for all conglomerate access methods.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BTREE_FACTORY_ID
static int	HEAP_FACTORY_ID

Fields inherited from interface org.apache.derby.iapi.store.access.conglomerate.MethodFactory

MODULE

Method Summary

Modifier and Type	Method and Description
Conglomerate	createConglomerate(TransactionManager xact_mgr, int segment, long input_containerid, DataValueDescriptor[] template, ColumnOrdering[] columnOrder, int[] collationIds, java.util.Properties properties, int temporaryFlag) Create the conglomerate and return a conglomerate object for it.
int	getConglomerateFactoryId() Return the conglomerate factory id.
Conglomerate	readConglomerate(TransactionManager xact_mgr, ContainerKey container_key) Return Conglomerate object for conglomerate with container_key.

Methods inherited from interface org.apache.derby.iapi.store.access.conglomerate.MethodFactory

defaultProperties, primaryFormat, primaryImplementationType, supportsFormat, supportsImplementation

Methods inherited from interface org.apache.derby.iapi.services.monitor.ModuleSupportable

canSupport

Field Detail

HEAP_FACTORY_ID

static final int HEAP_FACTORY_ID

See Also:

Constant Field Values

BTREE_FACTORY_ID

static final int BTREE_FACTORY_ID

See Also:

Constant Field Values

Method Detail

getConglomerateFactoryId

int getConglomerateFactoryId()

Return the conglomerate factory id.

Return a number in the range of 0-15 which identifies this factory. Code which names conglomerates depends on this range currently, but could be easily changed to handle larger ranges. One hex digit seemed reasonable for the number of conglomerate types currently implemented (heap, btree) and those that might be implemented in the future: gist, gist btree, gist rtree, hash, others? ).

Returns:

an unique identifier used to the factory into the conglomid.

createConglomerate

Conglomerate createConglomerate(TransactionManager xact_mgr,
                                int segment,
                                long input_containerid,
                                DataValueDescriptor[] template,
                                ColumnOrdering[] columnOrder,
                                int[] collationIds,
                                java.util.Properties properties,
                                int temporaryFlag)
                         throws StandardException

Create the conglomerate and return a conglomerate object for it. It is expected that the caller of this method will place the the resulting object in the conglomerate directory.

Parameters:

xact_mgr - transaction to perform the create in.

segment - segment to create the conglomerate in.

input_containerid - containerid to assign the container, or ContainerHandle.DEFAULT_ASSIGN_ID if you want raw store to assign an id.

template - Template of row in the conglomerate.

columnOrder - columns sort order for Index creation

collationIds - collation ids of columns in the conglomerate.

properties - Properties associated with the conglomerate.

Throws:

StandardException - if the conglomerate could not be opened for some reason, or if an error occurred in one of the lower level modules.

readConglomerate

Conglomerate readConglomerate(TransactionManager xact_mgr,
                              ContainerKey container_key)
                       throws StandardException

Return Conglomerate object for conglomerate with container_key.

Return the Conglomerate Object. This is implementation specific. Examples of what will be done is using the key to find the file where the conglomerate is located, and then executing implementation specific code to instantiate an object from reading a "special" row from a known location in the file. In the btree case the btree conglomerate is stored as a column in the control row on the root page.

This operation is costly so it is likely an implementation using this will cache the conglomerate row in memory so that subsequent accesses need not perform this operation.

Parameters:

xact_mgr - transaction to perform the create in.

container_key - The unique id of the existing conglomerate.

Returns:

An instance of the conglomerate.

Throws:

StandardException - Standard exception policy.