oracle.javatools.db.property

Class Metadata

java.lang.Object

oracle.javatools.db.property.Metadata

public final class Metadata
extends java.lang.Object

The database API contains a number of bean classes that represent the objects that can exist in a database (e.g. Tables, Columns, Constraints). This class provides meta-information about these bean classes and the properties available on them.

Since:

11

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Collection<java.lang.Class<? extends DBObject>>	getAllDBObjectClasses() Gets all DBObject classes that are registered with the metadata (that is, those that have an associated type String).
java.util.Collection<java.lang.String>	getAllTypes(java.lang.Class<? extends DBObject> clz) Gets all the valid DBObject types for the given class, including all subclasses and implementations.
java.util.Map<java.lang.String,java.lang.Class<? extends DBObject>>	getDBObjectClasses() The returned map contains a mapping of DBObject types to their declaring DBObject subclasses.
static Metadata	getInstance() Gets the metadata for the database API.
java.lang.Class<? extends DBObject>	getObjectClass(java.lang.String type) Gets the DBObject class that corresponds to the given object type.
java.util.Collection<java.lang.Class<? extends DBObject>>	getOwnerClasses(java.lang.Class<? extends DBObject> childClz) Gets the classes of all objects that can own a child of the given class.
java.util.Collection<java.lang.String>	getOwnerTypes(java.lang.String childType) Gets the object types of all objects that can own a child of the given type.
java.util.Collection<java.lang.String>	getSupportedProperties(java.lang.Class<? extends Copyable> objClz, java.lang.Class<? extends DBObjectProvider> proClz) Gets the supported properties, both defined on the bean class and also any extra properties registered via annotations or extensions, for the given object class in the context of the given provider class.
java.util.Collection<java.lang.String>	getSupportedProperties(java.lang.Class<? extends Copyable> objClz, java.lang.Class<? extends DBObjectProvider> proClz, boolean incBean, boolean incExtra) Gets the supported properties, both defined on the bean class and also any extra properties registered via annotations or extensions, for the given object class in the context of the given provider class.
static java.lang.String	getType(java.lang.Class<? extends DBObject> objClass) Returns the type defined for the given object class.
boolean	isBeanProperty(java.lang.Class<? extends DBObject> clz, java.lang.String propName) Tests whether a given property is a bean property (i.e.
static boolean	isRealBean(java.lang.Class<? extends Copyable> clz) Tests whether the given bean class is a concrete bean - i.e.
boolean	isSchemaObject(java.lang.String type) Returns true if the given DBObject type represents a SchemaObject.
boolean	isStaticReferenceProperty(java.lang.String propName) Tests whether the given property name is a static reference property, i.e.
boolean	isTypeOf(java.lang.Class<? extends DBObject> clz, java.lang.String type) Tests whether the given object type corresponds to a subclass of the given object class.
DBObject	newDBObject(java.lang.String type, java.lang.String name) Creates a new DBObject of given type, and sets it up with a name.
DBObject	newInstance(java.lang.String type) Creates a new instance of a DBObject of the given type.
void	registerBooleanProperty(java.lang.String name, Nullable.NullBehaviour nullBehaviour, java.lang.Class<? extends DBObjectProvider> providerType, java.lang.Class<? extends DBObject>... objectTypes) Registers a new Boolean property in the APIs metadata for a given object class and provider.
void	registerIDProperty(java.lang.String name, boolean staticReference, java.lang.Class<? extends DBObject> referencedClass, java.lang.String[] referencedTypes, java.lang.Class<? extends DBObjectProvider> providerType, java.lang.Class<? extends DBObject>... objectTypes) Registers a new property in the APIs metadata that has a return type of DBObjectID.
void	registerIDProperty(java.lang.String name, boolean staticReference, java.lang.Class<? extends DBObjectProvider> providerType, java.lang.Class<? extends DBObject>... objectTypes) Registers a new property in the APIs metadata that has a return type of DBObjectID.
void	registerObjectClass(java.lang.String type, java.lang.Class<? extends DBObject> clz) Registers a new object type with its corresponding DBObject implementation.
void	registerObjectClass(java.lang.String type, Thunk<java.lang.Class<? extends DBObject>> clzThunk) Registers a new object type with its corresponding DBObject implementation.
void	registerProperties(java.lang.Iterable<? extends PropertyInfo> infos) Registers extra properties into the API metadata.
void	registerProperty(PropertyInfo info) Registers an extra property into the API metadata.
void	registerProperty(java.lang.String name, java.lang.Class returnType, java.lang.Class<? extends DBObjectProvider> providerType, java.lang.Class<? extends DBObject>... objectTypes) Registers a new property in the APIs metadata for a given object class and provider.
void	registerStringProperty(java.lang.String name, boolean isMultiLine, java.lang.Class<? extends DBObjectProvider> providerType, java.lang.Class<? extends DBObject>... objectTypes) Registers a new property in the APIs metadata that has a return type of String.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Metadata getInstance()

Gets the metadata for the database API.

getAllDBObjectClasses

public java.util.Collection<java.lang.Class<? extends DBObject>> getAllDBObjectClasses()

Gets all DBObject classes that are registered with the metadata (that is, those that have an associated type String).

getDBObjectClasses

public java.util.Map<java.lang.String,java.lang.Class<? extends DBObject>> getDBObjectClasses()

The returned map contains a mapping of DBObject types to their declaring DBObject subclasses. The DBObject subclass could be an interface - not all DBobject classes will be returned by this method (more than one sometimes share a type).

Returns:

mappings of type to DBObject subclass

isSchemaObject

public boolean isSchemaObject(java.lang.String type)

Returns true if the given DBObject type represents a SchemaObject. Convinience method that just calls isTypeOf( SchemaObject.class, type )

isTypeOf

public boolean isTypeOf(java.lang.Class<? extends DBObject> clz,
               java.lang.String type)

Tests whether the given object type corresponds to a subclass of the given object class. For example to see if a type is a valid Relation:

   boolean isRelation = Metadata.getInstance().isTypeOf( Relation.class, type );
 

Parameters:

clz - the class to query (e.g. SystemObject.class)

type - the database object type (e.g. Table.TYPE )

Returns:

true if type corresponds to a valid subclass of clz

newDBObject

public DBObject newDBObject(java.lang.String type,
                   java.lang.String name)

Creates a new DBObject of given type, and sets it up with a name. Returns null if an object cannot be instantiated, or if the given object type has more than one registered implementation (e.g. Constraint).

Parameters:

type - the type of object to create

name - the name to give the object (optional)

Returns:

a new object of the given type setup with the given name, or null if a object couldn't be instantiated.

getObjectClass

public java.lang.Class<? extends DBObject> getObjectClass(java.lang.String type)

Gets the DBObject class that corresponds to the given object type.

Parameters:

type - the object type to lookup

Returns:

the DBObject subclass for that type

registerObjectClass

public void registerObjectClass(java.lang.String type,
                       Thunk<java.lang.Class<? extends DBObject>> clzThunk)

Registers a new object type with its corresponding DBObject implementation. The bean style properties on the given class will be automatically registered with the metadata. The class is wrapped in a Thunk for the registration of classes that might not be loaded yet, to delay class loading until it is absolutely necessary.

registerObjectClass

public void registerObjectClass(java.lang.String type,
                       java.lang.Class<? extends DBObject> clz)

Registers a new object type with its corresponding DBObject implementation. The bean style properties on the given class will be automatically registered with the metadata.

getAllTypes

public java.util.Collection<java.lang.String> getAllTypes(java.lang.Class<? extends DBObject> clz)

Gets all the valid DBObject types for the given class, including all subclasses and implementations.

newInstance

public DBObject newInstance(java.lang.String type)

Creates a new instance of a DBObject of the given type. Returns null if a new instance cannot be instantiated - for example some types are defined at the interface level and therefore cannot be instantiated.

Parameters:

type - the object type required ( e.g. "TABLE" )

Returns:

a new DBObject of the given type

getSupportedProperties

public java.util.Collection<java.lang.String> getSupportedProperties(java.lang.Class<? extends Copyable> objClz,
                                                            java.lang.Class<? extends DBObjectProvider> proClz)

Gets the supported properties, both defined on the bean class and also any extra properties registered via annotations or extensions, for the given object class in the context of the given provider class.

Parameters:

objClz - the object to query the properties for - cannot be null.

proClz - the provider class for the object - can be null if all registered properties are required.

Returns:

a list of the supported properties.

getSupportedProperties

public java.util.Collection<java.lang.String> getSupportedProperties(java.lang.Class<? extends Copyable> objClz,
                                                            java.lang.Class<? extends DBObjectProvider> proClz,
                                                            boolean incBean,
                                                            boolean incExtra)

Gets the supported properties, both defined on the bean class and also any extra properties registered via annotations or extensions, for the given object class in the context of the given provider class.

Parameters:

objClz - the object to query the properties for - cannot be null.

proClz - the provider class for the object - can be null if all registered properties are required.

incBean - include bean properties in the list

incExtra - include extra properties (registerd with the Metadata) in the list.

Returns:

a list of the supported properties.

registerProperty

public void registerProperty(java.lang.String name,
                    java.lang.Class returnType,
                    java.lang.Class<? extends DBObjectProvider> providerType,
                    java.lang.Class<? extends DBObject>... objectTypes)

Registers a new property in the APIs metadata for a given object class and provider. Any property registered here is expected to be used in the properties Map of the given DBObject implementation(s).

Parameters:

name - the property name

returnType - the expected return type for the property

providerType - the class of DBObjectProvider that this property is to be registered against (null or DBObjectProvider.class registers for all providers).

objectTypes - the object types this property is valid against (null or DBObject.class registers for all DBObjects).

registerBooleanProperty

public void registerBooleanProperty(java.lang.String name,
                           Nullable.NullBehaviour nullBehaviour,
                           java.lang.Class<? extends DBObjectProvider> providerType,
                           java.lang.Class<? extends DBObject>... objectTypes)

Registers a new Boolean property in the APIs metadata for a given object class and provider. Any property registered here is expected to be used in the properties Map of the given DBObject implementation(s).

Parameters:

name - the property name

nullBehaviour - the behaviour of the property regarding null as an allowed value

providerType - the class of DBObjectProvider that this property is to be registered against (null or DBObjectProvider.class registers for all providers).

objectTypes - the object types this property is valid against (null or DBObject.class registers for all DBObjects).

registerStringProperty

public void registerStringProperty(java.lang.String name,
                          boolean isMultiLine,
                          java.lang.Class<? extends DBObjectProvider> providerType,
                          java.lang.Class<? extends DBObject>... objectTypes)

Registers a new property in the APIs metadata that has a return type of String. Any property registered here is expected to be used in the properties Map of the given DBObject implementation(s).

Parameters:

name - the property name

isMultiLine - wher the String can contain newlines

providerType - the class of DBObjectProvider that this property is to be registered against (null or DBObjectProvider.class registers for all providers).

objectTypes - the object types this property is valid against (null or DBObject.class registers for all DBObjects).

registerIDProperty

public void registerIDProperty(java.lang.String name,
                      boolean staticReference,
                      java.lang.Class<? extends DBObjectProvider> providerType,
                      java.lang.Class<? extends DBObject>... objectTypes)

Registers a new property in the APIs metadata that has a return type of DBObjectID. Any property registered here is expected to be used in the properties Map of the given DBObject implementation(s).

Parameters:

name - the property name

staticReference - true if the property value is treated as a normal reference and replaced by the replaceReferenceIDs method on DBObject.

providerType - the class of DBObjectProvider that this property is to be registered against (null or DBObjectProvider.class registers for all providers).

objectTypes - the object types this property is valid against (null or DBObject.class registers for all DBObjects).

registerIDProperty

public void registerIDProperty(java.lang.String name,
                      boolean staticReference,
                      java.lang.Class<? extends DBObject> referencedClass,
                      java.lang.String[] referencedTypes,
                      java.lang.Class<? extends DBObjectProvider> providerType,
                      java.lang.Class<? extends DBObject>... objectTypes)

Registers a new property in the APIs metadata that has a return type of DBObjectID. Any property registered here is expected to be used in the properties Map of the given DBObject implementation(s).

Parameters:

name - the property name

staticReference - true if the property value is treated as a normal reference and replaced by the replaceReferenceIDs method on DBObject.

providerType - the class of DBObjectProvider that this property is to be registered against (null or DBObjectProvider.class registers for all providers).

objectTypes - the object types this property is valid against (null or DBObject.class registers for all DBObjects).

registerProperty

public void registerProperty(PropertyInfo info)

Registers an extra property into the API metadata.

Throws:

java.lang.IllegalArgumentException - if the PropertyInfo is not valid or a property is already registered with that name.

registerProperties

public void registerProperties(java.lang.Iterable<? extends PropertyInfo> infos)

Registers extra properties into the API metadata. The iterable will not be iterated until extra properties are requested from the metadata.

isStaticReferenceProperty

public boolean isStaticReferenceProperty(java.lang.String propName)

Tests whether the given property name is a static reference property, i.e. a property that should not be automatically replaced during copy or transfer operations.

Parameters:

propName - the name of the property to query

Returns:

true if the property is a static reference

isBeanProperty

public boolean isBeanProperty(java.lang.Class<? extends DBObject> clz,
                     java.lang.String propName)

Tests whether a given property is a bean property (i.e. has get/set methods) or whether it is an additional property registered with the api).

Parameters:

clz - the object type to test

propName - the property name to find

Returns:

true if the property is a bean property (i.e. the class has a get and set method for the property). If false is returned the property name or class could be invalid, or the property might be an additional property.

getOwnerTypes

public java.util.Collection<java.lang.String> getOwnerTypes(java.lang.String childType)

Gets the object types of all objects that can own a child of the given type. For example, getOwnerTypes( Column.TYPE ) will return all the Relation types that can own a Column.

Parameters:

childType - the child type to lookup

Returns:

all object types that can own a child of the given type

See Also:

getOwnerClasses(java.lang.Class<? extends oracle.javatools.db.DBObject>)

getOwnerClasses

public java.util.Collection<java.lang.Class<? extends DBObject>> getOwnerClasses(java.lang.Class<? extends DBObject> childClz)

Gets the classes of all objects that can own a child of the given class. For example, getOwnerClasses( Column.class ) will return all the Relation subclasses that can own a Column.

Parameters:

childClz - the child class to lookup

Returns:

all DBOObject implementationsthat can own a child of the given class

See Also:

getOwnerTypes(java.lang.String)

isRealBean

public static boolean isRealBean(java.lang.Class<? extends Copyable> clz)

Tests whether the given bean class is a concrete bean - i.e. not an interface or abstract class.

Parameters:

clz - the class to test

Returns:

true if it is a real, instantiable bean

getType

public static java.lang.String getType(java.lang.Class<? extends DBObject> objClass)

Returns the type defined for the given object class.

Parameters:

objClass - the class to lookup (e.g. Table.class)

Returns:

the type string for that object class (e.g. "TABLE")