oracle.javatools.db.property

Class AbstractPropertyManager

java.lang.Object

oracle.javatools.db.property.AbstractPropertyManager

All Implemented Interfaces:

PropertyManager

Direct Known Subclasses:

TokenDDLGenerator

public abstract class AbstractPropertyManager
extends java.lang.Object
implements PropertyManager

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPropertyManager(DBObjectProvider pro)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canAlterProperty(SystemObject original, SystemObject update, java.lang.String prop) Convenience method to call PropertyManager.canChangeProperty(oracle.javatools.db.SystemObject, oracle.javatools.db.SystemObject, java.lang.String) and check the return value is a PropertyAction with a type of ALTER.
PropertyAction	canChangeProperty(SystemObject original, SystemObject update, java.lang.String prop) Queries the support for setting or changing the given property for a create or update.
protected boolean	canChangeWithAlter(SystemObject orig, SystemObject update, java.lang.String prop) Returns true if the given property can be changed using an alter on the given original and updated objects.
protected boolean	canChangeWithReplace(SystemObject orig, SystemObject update, java.lang.String prop) Returns true if the given property can be changed using a drop/recreate on the given original and updated objects.
protected boolean	canCreate(java.lang.Class<? extends SystemObject> objClz, java.lang.String prop) Tests whether the given property is supported for create on the given object type.
protected boolean	canCreate(java.lang.String type, java.lang.String prop) Deprecated. replaced by canCreate(Class,String).
protected boolean	canCreate(SystemObject newObj, java.lang.String prop) Return true if the given property can be set on the given new object.
boolean	canCreateProperty(SystemObject obj, java.lang.String prop) Queries the support for setting or changing the given property for a create or update.
PropertyAction	canUpdateObject(Difference rs) Convenience method that uses PropertyManager.canChangeProperty(oracle.javatools.db.SystemObject, oracle.javatools.db.SystemObject, java.lang.String) on all the differences in the given Difference to tell whether the update on the given objects can be done using a CREATE, ALTER or REPLACE as appropriate.
PropertyAction	canUpdateObject(SystemObject orig, SystemObject update) Convenience method that uses PropertyManager.canChangeProperty(oracle.javatools.db.SystemObject, oracle.javatools.db.SystemObject, java.lang.String) on all the differences in the given object to tell whether the update on the given objects can be done using a CREATE, ALTER or REPLACE as appropriate.
PropertyInfo	findPropertyInfo(java.lang.Class<? extends DBObject> objClz, java.lang.String prop) Finds a PropertyInfo for the given property on the given object class.
java.util.Collection	getAllowedPropertyValues(DBObject originalObject, DBObject updatedObject, java.lang.String property) Gets the allowed property values for the given object and property in the described database.
java.util.Collection<java.lang.String>	getAllowedReferenceParentTypes(DBObject obj, java.lang.String property) Gets the allowed object types of the parent object for a given reference property.
java.util.Collection<java.lang.String>	getAllowedReferenceTypes(DBObject object, java.lang.String property) Gets the list of object types that can be referenced from the given property.
java.util.Collection<java.lang.String>	getAllowedReferenceTypes(PropertyInfo propInfo) Gets the list of object types that can be referenced from the given property.
java.util.Collection<java.lang.String>	getAllowedReferenceTypes(java.lang.String objectType, java.lang.String property) Gets the list of object types that can be referenced from the given property.
protected AbstractPropertyManager	getDelegate() Delegate mechanism for subclasses to implement if they wrap another PropertyManager implementation.
java.lang.Object	getImplicitDefaultValue(DBObject obj, java.lang.String property) Gets the implicit default value for the given object property, if one exists.
protected java.util.logging.Logger	getLogger() Returns a DBLog initialised Logger class for logging messages.
Nullable.NullBehaviour	getNullBehaviour(DBObject originalObject, DBObject updatedObject, java.lang.String property) Gets the null behaviour of the given object property.
protected Nullable.NullBehaviour	getNullBehaviour(PropertyInfo info, boolean edit) Used by getNullBehaviour(oracle.javatools.db.DBObject, oracle.javatools.db.DBObject, java.lang.String) to get the null behaviour for the given property.
protected PropertyHelper	getPropertyHelper() Gets a PropertyHelper that is cached for this PropertyManager implementation.
protected DBObjectProvider	getProvider()
protected java.lang.Class<? extends DBObjectProvider>	getProviderClass() Gets the provider class for the property support to test properties against.
java.util.Collection<java.lang.String>	getRestrictingProperties(java.lang.Class<? extends SystemObject> objClz, java.lang.String property) Gets a list of other property paths which restrict the canCreate/Replace/Alter support of the given system object property path.
protected boolean	isProcessorProperty(java.lang.Class<? extends SystemObject> clz, java.lang.String prop) Tests whether the given property is from an UpdateProcessor registered with the underlying provider's DatabaseDescriptor, rather than being a properly registered property with the Metadata.
boolean	supportsProperty(java.lang.Class<? extends DBObject> objClz, java.lang.String prop) Tests whether the given property is supported for the given object type.
boolean	supportsProperty(java.lang.String type, java.lang.String prop) Tests whether the given property is supported for the given object type.
PropertyAction	supportsPropertyChange(java.lang.Class<? extends SystemObject> objClz, java.lang.String prop) Tests whether the given property can be changed on the given system object type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.javatools.db.property.PropertyManager

supportsAction

Constructor Detail

AbstractPropertyManager

protected AbstractPropertyManager(DBObjectProvider pro)

Method Detail

getPropertyHelper

protected final PropertyHelper getPropertyHelper()

Gets a PropertyHelper that is cached for this PropertyManager implementation.

getDelegate

protected AbstractPropertyManager getDelegate()

Delegate mechanism for subclasses to implement if they wrap another PropertyManager implementation.

getLogger

protected java.util.logging.Logger getLogger()

Returns a DBLog initialised Logger class for logging messages.

getProvider

protected DBObjectProvider getProvider()

getProviderClass

protected java.lang.Class<? extends DBObjectProvider> getProviderClass()

Gets the provider class for the property support to test properties against. By default returns getProvider().getClass(), override if specific provider information is available.

supportsProperty

public final boolean supportsProperty(java.lang.String type,
                       java.lang.String prop)

Description copied from interface: PropertyManager

Tests whether the given property is supported for the given object type. The object type can be any type, not just a SystemObject type.

Specified by:

supportsProperty in interface PropertyManager

Parameters:

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

prop - the property name / path.

Returns:

true if the property is valid for the given object type in the provider for this property manager

supportsProperty

public boolean supportsProperty(java.lang.Class<? extends DBObject> objClz,
                       java.lang.String prop)

Description copied from interface: PropertyManager

Tests whether the given property is supported for the given object type. The object class can be a child type, and not just a a subclass of SystemObject.

Specified by:

supportsProperty in interface PropertyManager

Parameters:

objClz - the object class (e.g. Table.class or Column.class ).

prop - the property name / path.

Returns:

true if the property is valid for the given object class in the provider for this property manager

supportsPropertyChange

public PropertyAction supportsPropertyChange(java.lang.Class<? extends SystemObject> objClz,
                                    java.lang.String prop)

Description copied from interface: PropertyManager

Tests whether the given property can be changed on the given system object type.

If the property is a child property, and ALTER is supported then the action may contain child information (e.g. whether children can be added/removed/modified) via the supportsChildAction method.

Specified by:

supportsPropertyChange in interface PropertyManager

Parameters:

objClz - the type of system object to test

prop - the property (can be a path) that we want to change

Returns:

null if the property cannot be changed, otherwise a PropertyAction describing the action on the SystemObject required to make a change.

See Also:

PropertyAction.supportsChildAction(oracle.javatools.db.property.PropertyAction.ChildAction)

findPropertyInfo

public PropertyInfo findPropertyInfo(java.lang.Class<? extends DBObject> objClz,
                            java.lang.String prop)

Description copied from interface: PropertyManager

Finds a PropertyInfo for the given property on the given object class. The object class can be any DBObject, not just a SystemObject. This is more specific than using PropertyHelper.findPropertyInfo directly as it allows a provider's PropertyManager to customise which properties are supported.

Specified by:

findPropertyInfo in interface PropertyManager

Parameters:

objClz - the object class (e.g. Column.class ).

prop - the property name / path.

Returns:

an object describing the property

canCreateProperty

public boolean canCreateProperty(SystemObject obj,
                        java.lang.String prop)

Description copied from interface: PropertyManager

Queries the support for setting or changing the given property for a create or update. If the original object is null then the request is to test whether the given property is settable on a new object. If the original object is not null the request is to test whether the given property can be changed, and if so whether the change can be applied by an update/alter or whether a replace/recreate is needed.

Specified by:

canCreateProperty in interface PropertyManager

prop - the property name / path to query

Returns:

an appropriate property action indicating the level of support for that property if supported, or null if the property is not supported.

canAlterProperty

public final boolean canAlterProperty(SystemObject original,
                       SystemObject update,
                       java.lang.String prop)

Description copied from interface: PropertyManager

Convenience method to call PropertyManager.canChangeProperty(oracle.javatools.db.SystemObject, oracle.javatools.db.SystemObject, java.lang.String) and check the return value is a PropertyAction with a type of ALTER.

Specified by:

canAlterProperty in interface PropertyManager

Parameters:

original - the original object (null for a create query)

update - the updated (or new) object

prop - the property name / path to query

Returns:

true if the given property can be changed using ALTER.

canChangeProperty

public final PropertyAction canChangeProperty(SystemObject original,
                               SystemObject update,
                               java.lang.String prop)

Description copied from interface: PropertyManager

Queries the support for setting or changing the given property for a create or update. If the original object is null then the request is to test whether the given property is settable on a new object. If the original object is not null the request is to test whether the given property can be changed, and if so whether the change can be applied by an update/alter or whether a replace/recreate is needed.

Specified by:

canChangeProperty in interface PropertyManager

Parameters:

original - the original object (null for a create query)

update - the updated (or new) object

prop - the property name / path to query

Returns:

an appropriate property action indicating the level of support for that property if supported, or null if the property is not supported.

canCreate

protected boolean canCreate(SystemObject newObj,
                java.lang.String prop)

Return true if the given property can be set on the given new object. By default this calls canCreate(Class,String) with the object type.

canCreate

protected boolean canCreate(java.lang.Class<? extends SystemObject> objClz,
                java.lang.String prop)

Tests whether the given property is supported for create on the given object type.

Parameters:

objClz - the SystemObject subclass the property is defined against.

prop - the property (or property path) to test

Returns:

true if the property can be defined on create.

canCreate

@Deprecated
protected boolean canCreate(java.lang.String type,
                           java.lang.String prop)

Deprecated. replaced by canCreate(Class,String).

canChangeWithAlter

protected boolean canChangeWithAlter(SystemObject orig,
                         SystemObject update,
                         java.lang.String prop)

Returns true if the given property can be changed using an alter on the given original and updated objects.

canChangeWithReplace

protected boolean canChangeWithReplace(SystemObject orig,
                           SystemObject update,
                           java.lang.String prop)

Returns true if the given property can be changed using a drop/recreate on the given original and updated objects.

canUpdateObject

public final PropertyAction canUpdateObject(SystemObject orig,
                             SystemObject update)

Description copied from interface: PropertyManager

Convenience method that uses PropertyManager.canChangeProperty(oracle.javatools.db.SystemObject, oracle.javatools.db.SystemObject, java.lang.String) on all the differences in the given object to tell whether the update on the given objects can be done using a CREATE, ALTER or REPLACE as appropriate.

Specified by:

canUpdateObject in interface PropertyManager

Parameters:

orig - the original object (null for a create query)

update - the updated (or new) object

Returns:

an appropriate property action indicating the level support if the update is supported, or null if the update is not supported.

canUpdateObject

public final PropertyAction canUpdateObject(Difference rs)

Description copied from interface: PropertyManager

Convenience method that uses PropertyManager.canChangeProperty(oracle.javatools.db.SystemObject, oracle.javatools.db.SystemObject, java.lang.String) on all the differences in the given Difference to tell whether the update on the given objects can be done using a CREATE, ALTER or REPLACE as appropriate. The Difference must be a diff of two SystemObjects.

Specified by:

canUpdateObject in interface PropertyManager

Parameters:

rs - the changes to test

Returns:

an appropriate property action indicating the level support if the update is supported, or null if the update is not supported.

getAllowedPropertyValues

public java.util.Collection getAllowedPropertyValues(DBObject originalObject,
                                            DBObject updatedObject,
                                            java.lang.String property)

Description copied from interface: PropertyManager

Gets the allowed property values for the given object and property in the described database. This can return null to indicate no restriction, or an empty list to indicate that the property has no allowed values for the described database. In the latter case the property should already be marked as unsupported by the provider's PropertyManager.

Specified by:

getAllowedPropertyValues in interface PropertyManager

updatedObject - the object the property is on

property - the property to check

Returns:

the allowed values for the property, or null if the property is not restricted.

getRestrictingProperties

public java.util.Collection<java.lang.String> getRestrictingProperties(java.lang.Class<? extends SystemObject> objClz,
                                                              java.lang.String property)

Description copied from interface: PropertyManager

Gets a list of other property paths which restrict the canCreate/Replace/Alter support of the given system object property path.

Specified by:

getRestrictingProperties in interface PropertyManager

property - the full path of the property

Returns:

the list of property paths that affect the support for the given property path

getNullBehaviour

public Nullable.NullBehaviour getNullBehaviour(DBObject originalObject,
                                      DBObject updatedObject,
                                      java.lang.String property)

Description copied from interface: PropertyManager

Gets the null behaviour of the given object property. This can differ from the default from the underlying PropertyInfo, especially on create or edit.

Specified by:

getNullBehaviour in interface PropertyManager

Parameters:

originalObject - the original object, or null if this isn't an edit.

updatedObject - the updated object (must not be null).

property - the property to test.

Returns:

the null behaviour of the property, or null if the property is not known to this property manager.

getNullBehaviour

protected Nullable.NullBehaviour getNullBehaviour(PropertyInfo info,
                                      boolean edit)

Used by getNullBehaviour(oracle.javatools.db.DBObject, oracle.javatools.db.DBObject, java.lang.String) to get the null behaviour for the given property.

Parameters:

info - the property.

edit - whether we're editing or not.

Returns:

the null behaviour for the property.

getAllowedReferenceTypes

public java.util.Collection<java.lang.String> getAllowedReferenceTypes(DBObject object,
                                                              java.lang.String property)

Description copied from interface: PropertyManager

Gets the list of object types that can be referenced from the given property. Returns null if the property is not restircted (or not a reference property).

Specified by:

getAllowedReferenceTypes in interface PropertyManager

Parameters:

object - the object the reference is from

property - the reference property name

Returns:

the list of allowed types for the reference DBObjectID, or null if the property doesn't exist or isn't a reference property.

getAllowedReferenceTypes

public final java.util.Collection<java.lang.String> getAllowedReferenceTypes(java.lang.String objectType,
                                                              java.lang.String property)

Description copied from interface: PropertyManager

Gets the list of object types that can be referenced from the given property.

Specified by:

getAllowedReferenceTypes in interface PropertyManager

Parameters:

objectType - the type of object the reference is from

property - the reference property name

Returns:

the list of allowed types for the reference DBObjectID, or null if the property doesn't exist or isn't a reference property.

getAllowedReferenceTypes

public java.util.Collection<java.lang.String> getAllowedReferenceTypes(PropertyInfo propInfo)

Description copied from interface: PropertyManager

Gets the list of object types that can be referenced from the given property.

Specified by:

getAllowedReferenceTypes in interface PropertyManager

Parameters:

propInfo - the PropertyInfo for the property to test

Returns:

the list of allowed types for the reference DBObjectID, or null if the property doesn't exist or isn't a reference property.

getAllowedReferenceParentTypes

public java.util.Collection<java.lang.String> getAllowedReferenceParentTypes(DBObject obj,
                                                                    java.lang.String property)

Description copied from interface: PropertyManager

Gets the allowed object types of the parent object for a given reference property.

For example for an FKConstraint referenceID property this will return Table.TYPE.

Specified by:

getAllowedReferenceParentTypes in interface PropertyManager

Parameters:

obj - the object the property is set on

property - the name of the property to lookup

Returns:

the DBObject types of the allowed parent objects of the referenced object, or null if the property doesn't exist or isn't a reference property.

getImplicitDefaultValue

public java.lang.Object getImplicitDefaultValue(DBObject obj,
                                       java.lang.String property)

Description copied from interface: PropertyManager

Gets the implicit default value for the given object property, if one exists. This is only relevant for properties that are nullable, if null means "Not Specified" then the default is not of interest.

Specified by:

getImplicitDefaultValue in interface PropertyManager

Parameters:

obj - the object the property is on

property - the property name

Returns:

a default value that will be set implictly on create of the given object if the property isn't specified.

isProcessorProperty

protected final boolean isProcessorProperty(java.lang.Class<? extends SystemObject> clz,
                          java.lang.String prop)

Tests whether the given property is from an UpdateProcessor registered with the underlying provider's DatabaseDescriptor, rather than being a properly registered property with the Metadata.

Parameters:

clz - the object class the property is on

prop - the property to test

Returns:

true if the property comes from an UpdateProcessor.