Most of this code is generic to all conglomerates. This class might be more easily maintained as an abstract class in Raw/Conglomerate/Generic. The concrete ConglomerateFactories would simply have to supply the IMPLEMENTATIONID, FORMATUUIDSTRING, and implement createConglomerate and defaultProperties. Conglomerates which support more than one format would have to override supportsFormat, and conglomerates which support more than one implementation would have to override supportsImplementation.
| Modifier and Type | Field and Description |
|---|---|
| private UUID | |
| private static final String | |
| private static final String |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public void | boot(boolean
True if the database should be created create, Properties Configuration properties startParams)Implements org. Boot this module with the given properties. |
| public boolean | canSupport(Properties startParams)
Implements org. See if this implementation can support any attributes that are listed in properties. |
| public Conglomerate | createConglomerate(TransactionManager
transaction to perform the create in. xact_mgr, int segment to create the conglomerate in. segment, long containerid to assign the container, or
ContainerHandle.DEFAULT_ASSIGN_ID if you want
raw store to assign an id. input_containerid, DataValueDescriptor[] Template of row in the conglomerate. template, ColumnOrdering[] columns sort order for Index creation columnOrder, int[] collation ids of columns in the conglomerate. collationIds, Properties Properties associated with the conglomerate. properties, int temporaryFlag)Implements org. Create the conglomerate and return a conglomerate object for it. |
| public Properties | defaultProperties()
Implements org. Return the default properties for this kind of conglomerate. |
| public int | Returns: an unique identifier used to the factory into the conglomid.Implements org. Return the conglomerate factory id. Return a number in the range of 0-15 which identifies this factory. |
| private static ModuleFactory | |
| public void | insertUndoNotify(AccessFactory
current access_factory of the aborted insert. access_factory, Transaction transaction that is being backed out. xact, PageKey page key of the aborted insert. page_key)Implements org. Interface to be called when an undo of an insert is processed. |
| public UUID | primaryFormat()
Implements org. Return the primary format that this access method supports. |
| public String | primaryImplementationType()
Implements org. Return the primary implementation type for this access method. |
| public Conglomerate | Returns: An instance of the conglomerate.transaction to perform the create in. xact_manager, ContainerKey The unique id of the existing conglomerate. container_key)Implements org. Return Conglomerate object for conglomerate with conglomid. |
| public void | |
| public boolean | supportsFormat(UUID formatid)
Implements org. Return whether this access method supports the format supplied in the argument. |
| public boolean | supportsImplementation(String implementationId)
Implements org. Return whether this access method implements the implementation type given in the argument string. |
| formatUUID | back to summary |
|---|---|
| private UUID formatUUID | |
| FORMATUUIDSTRING | back to summary |
|---|---|
| private static final String FORMATUUIDSTRING | |
| IMPLEMENTATIONID | back to summary |
|---|---|
| private static final String IMPLEMENTATIONID | |
| B2IFactory | back to summary |
|---|---|
| public B2IFactory() | |
| boot | back to summary |
|---|---|
| public void boot(boolean create, Properties startParams) throws StandardException Implements org. Doc from org. Boot this module with the given properties. Creates a module instance that can be found using the findModule() methods of Monitor. The module can only be found using one of these findModule() methods once this method has returned. An implementation's boot method can throw StandardException. If it is thrown the module is not registered by the monitor and therefore cannot be found through a findModule(). In this case the module's stop() method is not called, thus throwing this exception must free up any resources.
When create is true the contents of the properties object
will be written to the service.properties of the persistent
service. Thus any code that requires an entry in service.properties
must explicitly place the value in this properties set
using the put method.
When create is false the properties object contains all the properties set in the service.properties file plus a limited number of attributes from the JDBC URL attributes or connection properties set. This avoids properties set by the user compromising the boot process. An example of a property passed in from the JDBC world is the bootPassword for encrypted databases. Code should not hold onto the passed in properties reference after boot time as its contents may change underneath it. At least after the complete boot is completed, the links to all the default sets will be removed.
| |
| canSupport | back to summary |
|---|---|
| public boolean canSupport(Properties startParams) Implements org. Doc from org. See if this implementation can support any attributes that are listed in properties. This call may be made on a newly created instance before the boot() method has been called, or after the boot method has been called for a running module.
The module can check for attributes in the properties to
see if it can fulfill the required behaviour. E.g. the raw
store may define an attribute called RawStore.Recoverable.
If a temporary raw store is required the property RawStore.recoverable=false
would be added to the properties before calling bootServiceModule. If a
raw store cannot support this attribute its canSupport method would
return null. Also see the Monitor class's prologue to see how the
identifier is used in looking up properties.
| |
| defaultProperties | back to summary |
|---|---|
| public Properties defaultProperties() Implements org. Return the default properties for this kind of conglomerate. | |
| getConglomerateFactoryId | back to summary |
|---|---|
| public int getConglomerateFactoryId() Implements org. 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 being currently considered (heap, btree, gist, gist btree, gist rtree, hash, others? ).
| |
| getMonitor | back to summary |
|---|---|
| private static ModuleFactory getMonitor() Must be private so that user code can't call this entry point. | |
| insertUndoNotify | back to summary |
|---|---|
| public void insertUndoNotify(AccessFactory access_factory, Transaction xact, PageKey page_key) throws StandardException Implements org. Interface to be called when an undo of an insert is processed. Implementer of this class provides interface to be called by the raw store when an undo of an insert is processed. Initial implementation will be by Access layer to queue space reclaiming events if necessary when a rows is logically "deleted" as part of undo of the original insert. This undo can happen a lot for many applications if they generate expected and handled duplicate key errors. Caller may decide to call or not based on deleted row count of the page, or if overflow rows/columns are present.
| |
| primaryFormat | back to summary |
|---|---|
| public UUID primaryFormat() Implements org. Return the primary format that this access method supports. The btree currently only supports one format. | |
| primaryImplementationType | back to summary |
|---|---|
| public String primaryImplementationType() Implements org. Return the primary implementation type for this access method. The btree only has one implementation type, "BTREE". | |
| readConglomerate | back to summary |
|---|---|
| public Conglomerate readConglomerate(TransactionManager xact_manager, ContainerKey container_key) throws StandardException Implements org. Return Conglomerate object for conglomerate with conglomid. Return the Conglomerate Object. This is implementation specific. Examples of what will be done is using the id 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. The btree object returned by this routine may be installed in a cache so the object must not change.
| |
| stop | back to summary |
|---|---|
| public void stop() Implements org. Doc from org. Stop the module. The module may be found via a findModule() method until some time after this method returns. Therefore the factory must be prepared to reject requests to it once it has been stopped. In addition other modules may cache a reference to the module and make requests of it after it has been stopped, these requests should be rejected as well. | |
| supportsFormat | back to summary |
|---|---|
| public boolean supportsFormat(UUID formatid) Implements org. Return whether this access method supports the format supplied in the argument. The btree currently only supports one format. | |
| supportsImplementation | back to summary |
|---|---|
| public boolean supportsImplementation(String implementationId) Implements org. Return whether this access method implements the implementation type given in the argument string. The btree only has one implementation type, "BTREE". | |