oracle.javatools.db.property

Interface PropertyManager

All Known Subinterfaces:

DDLGenerator<T>

All Known Implementing Classes:

AbstractPropertyManager, BundleDDLGenerator, DelegateDDLGenerator, TokenDDLGenerator

public interface PropertyManager

A DBObjectProvider has an associated PropertyManager that can be queried to ask for the level of support a given property has.

Since:

11

Method Summary

Modifier and Type	Method and Description
boolean	canAlterProperty(SystemObject original, SystemObject update, java.lang.String prop) Convenience method to call 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.
boolean	canCreateProperty(SystemObject object, 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 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 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.
java.lang.Object	getImplicitDefaultValue(DBObject obj, java.lang.String property) Gets the implicit default value for the given object property, if one exists.
Nullable.NullBehaviour	getNullBehaviour(DBObject originalObject, DBObject updatedObject, java.lang.String property) Gets the null behaviour of the given object property.
java.util.Map<java.lang.String,PropertyInfo>	getPropertyInfos(java.lang.Class<? extends DBObject> objClass, PropertyCriteria criteria) Gets the PropertyInfos (mapped by their property name) for the given object class that are supported by this PropertyManager's DBObjectProvider.
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.
boolean	supportsAction(java.lang.String type, PropertyAction.Type action) Asks whether a given action is supported for the specified object type in this provider.
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.

Method Detail

supportsAction

boolean supportsAction(java.lang.String type,
                       PropertyAction.Type action)

Asks whether a given action is supported for the specified object type in this provider. The type must be a SystemObject type.

supportsProperty

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

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

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

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

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.

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

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.

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.

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)

getPropertyInfos

java.util.Map<java.lang.String,PropertyInfo> getPropertyInfos(java.lang.Class<? extends DBObject> objClass,
                                                              PropertyCriteria criteria)

Gets the PropertyInfos (mapped by their property name) for the given object class that are supported by this PropertyManager's DBObjectProvider.

To list properties generically (outside the context of a DBObjectProvider) see PropertyHelper.getPropertyInfos(java.lang.Class<?>, java.lang.Class<? extends oracle.javatools.db.DBObjectProvider>, oracle.javatools.db.property.PropertyCriteria).

Parameters:

objClass - the object class to list properties for

criteria - the criteria for lookup (can be null to list all non-deprecated properties). The given criteria might be modified (by having a predicate added) by the implementation.

Returns:

a map of all supported properties, key'd by name

findPropertyInfo

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

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.

To find a property generically (outside the context of a DBObjectProvider) see PropertyHelper.findPropertyInfo(java.lang.String, java.lang.String, java.lang.Class<? extends oracle.javatools.db.DBObjectProvider>).

Parameters:

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

prop - the property name / path.

Returns:

an object describing the property

canCreateProperty

boolean canCreateProperty(SystemObject object,
                          java.lang.String prop)

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.

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.

canChangeProperty

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. 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.

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.

canAlterProperty

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

Convenience method to call 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.

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.

canUpdateObject

PropertyAction canUpdateObject(SystemObject orig,
                               SystemObject update)

Convenience method that uses 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.

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

PropertyAction canUpdateObject(Difference rs)

Convenience method that uses 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.

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.

Throws:

java.lang.ClassCastException - if the objects in the Difference are not SystemObjects.

getAllowedPropertyValues

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. 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.

Parameters:

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

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.

Parameters:

class - of the SystemObject that the property is on

property - the full path of the property

Returns:

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

getNullBehaviour

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

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

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.

getAllowedReferenceTypes

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. Returns null if the property is not restircted (or not a reference property).

Parameters:

object - the object the reference is from

property - the reference property name

the - provider the referencing object is from

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

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.

Parameters:

objectType - the type of object the reference is from

property - the reference property name

the - provider the referencing object is from

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

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

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

Parameters:

propInfo - the PropertyInfo for the property to test

the - provider the referencing object is from

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

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.

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

Parameters:

obj - the object the property is set on

property - the name of the property to lookup

pro - the current provider

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

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

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.

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.