oracle.javatools.db.extension

Class DBObjectRegistry

java.lang.Object

oracle.javatools.db.extension.DBObjectRegistry

public final class DBObjectRegistry
extends java.lang.Object

Registry where objects from outside of the db-api can be registered with existing provider implementations.

Since:

11.1.1.4.0

Constructor Summary

Constructors

Constructor and Description
DBObjectRegistry()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,DBObjectBuilder>	getBuilders(java.lang.String dbType, int version, DBObjectProvider pro)
java.util.Map<java.lang.String,DDLGenerator>	getDDLGenerators(Database db)
java.util.Map<java.lang.String,DDLGenerator>	getDDLGenerators(java.lang.String dbType, int version, java.lang.Class<? extends Database> dbClz, DBObjectProvider pro)
static DBObjectRegistry	getInstance() Gets the single instance of the DBObjectRegistry.
java.util.Map<java.lang.String,DBObjectLister>	getListers(java.lang.String dbType, int version, DBObjectProvider pro)
java.util.Map<java.lang.String,DBObjectValidator>	getValidators(java.lang.String dbType, int version, DBObjectProvider pro)
static boolean	isActive() Tests whether the DBObjectRegistry has been used yet (i.e.
static boolean	isExtensionType(java.lang.String objType, java.lang.String dbType, int dbVersion) Tests whether the DBObjectRegistry has been initialized and the given object type is a registered extension of a particular database type and version.
void	registerClass(java.lang.String objType, java.lang.Class<? extends DBObject> objClz) Registers the given object type and class with the api's metadata layer.
void	registerClass(java.lang.String objType, Thunk<java.lang.Class<? extends DBObject>> objClz) Registers the given object type and class with the api's metadata layer.
void	registerObject(java.lang.String objType, DatabaseMatcher dbMatch, java.lang.Class<? extends DBObjectValidator> validatorClz, java.lang.Class<? extends DBObjectBuilder> builderClz, java.lang.Class<? extends DBObjectLister> listClz, java.lang.Class<? extends DDLGenerator> ddlGenClz) Registers a new object type with the releveant components for making it function within the API.
void	registerObject(java.lang.String objType, DatabaseMatcher dbMatch, Thunk<java.lang.Class<? extends DBObjectValidator>> validatorClz, Thunk<java.lang.Class<? extends DBObjectBuilder>> builderClz, Thunk<java.lang.Class<? extends DBObjectLister>> listClz, Thunk<java.lang.Class<? extends DDLGenerator>> ddlGenClz) Registers a new object type with the releveant components for making it function within the API.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DBObjectRegistry

public DBObjectRegistry()

Method Detail

getValidators

public java.util.Map<java.lang.String,DBObjectValidator> getValidators(java.lang.String dbType,
                                                              int version,
                                                              DBObjectProvider pro)

getBuilders

public java.util.Map<java.lang.String,DBObjectBuilder> getBuilders(java.lang.String dbType,
                                                          int version,
                                                          DBObjectProvider pro)

getListers

public java.util.Map<java.lang.String,DBObjectLister> getListers(java.lang.String dbType,
                                                        int version,
                                                        DBObjectProvider pro)

getDDLGenerators

public java.util.Map<java.lang.String,DDLGenerator> getDDLGenerators(Database db)

getDDLGenerators

public java.util.Map<java.lang.String,DDLGenerator> getDDLGenerators(java.lang.String dbType,
                                                            int version,
                                                            java.lang.Class<? extends Database> dbClz,
                                                            DBObjectProvider pro)

registerObject

public void registerObject(java.lang.String objType,
                  DatabaseMatcher dbMatch,
                  java.lang.Class<? extends DBObjectValidator> validatorClz,
                  java.lang.Class<? extends DBObjectBuilder> builderClz,
                  java.lang.Class<? extends DBObjectLister> listClz,
                  java.lang.Class<? extends DDLGenerator> ddlGenClz)

Registers a new object type with the releveant components for making it function within the API.

This must be done after a call to registerClass to register the DBObject implementation class against the same type.

Parameters:

objType - the type of object

dbMatch - the matcher to define which database/versions it is supported for

validatorClz - for validating the object definition (should have a constructor that takes a single DBObjectProvider)

builderClz - the building the object definition from the database dictionary (should have a constructor that takes a single DBObjectProvider)

listClz - the lister for listing avaiable objects of from the database (should have a constructor that takes a single DBObjectProvider)

ddlGenClz - the generator for constructing ddl syntax for the create/update/delete of the object type (should have a constructor that takes Class<? extends Database>, DBObjectProvider

registerObject

public void registerObject(java.lang.String objType,
                  DatabaseMatcher dbMatch,
                  Thunk<java.lang.Class<? extends DBObjectValidator>> validatorClz,
                  Thunk<java.lang.Class<? extends DBObjectBuilder>> builderClz,
                  Thunk<java.lang.Class<? extends DBObjectLister>> listClz,
                  Thunk<java.lang.Class<? extends DDLGenerator>> ddlGenClz)

Registers a new object type with the releveant components for making it function within the API.

This must be done after a call to registerClass to register the DBObject implementation class against the same type.

All of the Class parameters take a Thunk to provide a level of indirection allowing the ClassLoading to be delayed until necessary.

Parameters:

objType - the type of object

dbMatch - the matcher to define which database/versions it is supported for

validatorClz - for validating the object definition (should have a constructor that takes a single DBObjectProvider)

builderClz - the building the object definition from the database dictionary (should have a constructor that takes a single DBObjectProvider)

listClz - the lister for listing avaiable objects of from the database (should have a constructor that takes a single DBObjectProvider)

ddlGenClz - the generator for constructing ddl syntax for the create/update/delete of the object type (should have a constructor that takes Class<? extends Database>, DBObjectProvider

registerClass

public void registerClass(java.lang.String objType,
                 java.lang.Class<? extends DBObject> objClz)

Registers the given object type and class with the api's metadata layer.

Parameters:

objType - the new DBObject type to register

objClz - the DBObject implementation class for the new type

registerClass

public void registerClass(java.lang.String objType,
                 Thunk<java.lang.Class<? extends DBObject>> objClz)

Registers the given object type and class with the api's metadata layer. A Thunk is used to wrap the class so that the class can be loaded when required rather than immediately.

Parameters:

objType - the new DBObject type to register

objClz - a Thunk that contains the the DBObject implementation class for the new type

getInstance

public static DBObjectRegistry getInstance()

Gets the single instance of the DBObjectRegistry. Test for existence with isActive() first.

isActive

public static boolean isActive()

Tests whether the DBObjectRegistry has been used yet (i.e. whether anything is likely to be registered).

isExtensionType

public static boolean isExtensionType(java.lang.String objType,
                      java.lang.String dbType,
                      int dbVersion)

Tests whether the DBObjectRegistry has been initialized and the given object type is a registered extension of a particular database type and version.

Parameters:

objType - the object type to test

dbType - the database type to match

dbVersion - the database version to match

Returns:

true if objType is a regsitered extension for the given database type and version.