oracle.javatools.db.property

Class PropertyHelper

java.lang.Object

oracle.javatools.db.property.PropertyHelper

public final class PropertyHelper
extends java.lang.Object

Helper class that allows you to get the value for a given property (path) on an object. When a property has a get/set method this ensures that the value is of the right type (e.g. calling getProperty for a child list returns a List, but using a PropertyHelper will return an array). It is therefore recommended for property frameworks such as SXML and DDL generation.

Since:

11

Constructor Summary

Constructors

Constructor and Description
PropertyHelper() Creates a generic PropertyHelper that is not tied to a particular provider.
PropertyHelper(DBObjectProvider pro) Creates a generic PropertyHelper for the given provider.

Method Summary

Methods

Modifier and Type	Method and Description
static PropertyInfo	findPropertyInfo(java.lang.Class clz, java.lang.String propPath, java.lang.Class<? extends DBObjectProvider> proClz) If the given property path is supported for the given object class this method returns the PropertyInfo associated with that property.
static PropertyInfo	findPropertyInfo(java.lang.Class clz, java.lang.String propPath, DBObjectProvider pro) If the given property path is supported for the given object class this method returns the PropertyInfo associated with that property.
static PropertyInfo	findPropertyInfo(java.lang.String type, java.lang.String propPath, java.lang.Class<? extends DBObjectProvider> proClz) If the given property path is supported for the given object class this method returns the PropertyInfo associated with that property.
Difference	getChildDifference(Difference diff, java.lang.String propPath) Traverses the given difference looking for a Difference heirachy that matches the given property path, and returns the Difference at the end of that path if one is found.
Difference	getChildDifference(Difference diff, java.lang.String propPath, boolean ignoreSame) Traverses the given difference looking for a Difference heirachy that matches the given property path, and returns the Difference at the end of that path if one is found.
java.lang.Object	getPropertyValue(java.lang.Object obj, java.lang.String propPath) Gets the value for the given property path on the given object.
java.lang.Object	getPropertyValueOrFail(java.lang.Object obj, java.lang.String propPath) Gets the value for the given property path on the given object, or throws a MissingPropertyException if the path is not valid.
void	setPropertyValue(java.lang.Object bean, java.lang.String propPath, java.lang.Object value) Sets property value on a given object.
void	setPropertyValueOrFail(java.lang.Object object, java.lang.String propPath, java.lang.Object value) Sets property value on a given object.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyHelper

public PropertyHelper()

Creates a generic PropertyHelper that is not tied to a particular provider. This means that finding PropertyInfos (e.g. for creating missing beans in a property path) will not follow provider specific logic.

PropertyHelper

public PropertyHelper(DBObjectProvider pro)

Creates a generic PropertyHelper for the given provider. The provider is used to lookup PropertyInfos via the PropertyManager.

Parameters:

pro - the DBObjectProvider that contains the objects we will query

Method Detail

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.Object obj,
                                java.lang.String propPath)

Gets the value for the given property path on the given object.

Parameters:

obj - the object to query

propPath - the property path to lookup

Returns:

the property value (can be null), or null if the property doesn't exist.

See Also:

getPropertyValueOrFail(Object,String)

getPropertyValueOrFail

public java.lang.Object getPropertyValueOrFail(java.lang.Object obj,
                                      java.lang.String propPath)
                                        throws MissingPropertyException

Gets the value for the given property path on the given object, or throws a MissingPropertyException if the path is not valid.

Parameters:

obj - the object to query

propPath - the property path to lookup

Returns:

the propery value (can be null)

Throws:

MissingPropertyException - if any part of the property path is not found

setPropertyValue

public void setPropertyValue(java.lang.Object bean,
                    java.lang.String propPath,
                    java.lang.Object value)

Sets property value on a given object. Property can be a set method of the bean or part of a key in it's property map. In the latter case if value is null then the property mapping is removed.

If the path contains simple child beans that do not exist, and can be created, then they will be instantiated and set as part of the operation.

Parameters:

bean - the object to set the property on

propPath - the property path to the property we want to set

value - the property value to set

See Also:

setPropertyValueOrFail(Object,String,Object)

setPropertyValueOrFail

public void setPropertyValueOrFail(java.lang.Object object,
                          java.lang.String propPath,
                          java.lang.Object value)
                            throws MissingPropertyException

Sets property value on a given object. Property can be a set method of the bean or part of a key in it's property map. In the latter case if value is null then the property mapping is removed.

If the path contains simple child beans that do not exist, and can be created, then they will be instantiated and set as part of the operation.

Parameters:

object - the object to set the property on

propPath - the property path to the property we want to set

value - the property value to set

Throws:

MissingPropertyException - if the property path is not valid

getChildDifference

public Difference getChildDifference(Difference diff,
                            java.lang.String propPath)
                              throws MissingPropertyException

Traverses the given difference looking for a Difference heirachy that matches the given property path, and returns the Difference at the end of that path if one is found.

Parameters:

diff - the parent Difference

propPath - the property path to resolve from the object in the parent Difference.

Returns:

the found child Difference, or null.

Throws:

MissingPropertyException - if the path is invalid

getChildDifference

public Difference getChildDifference(Difference diff,
                            java.lang.String propPath,
                            boolean ignoreSame)
                              throws MissingPropertyException

Traverses the given difference looking for a Difference heirachy that matches the given property path, and returns the Difference at the end of that path if one is found.

Parameters:

diff - the parent Difference

propPath - the property path to resolve from the object in the parent Difference.

ignoreSame - if true only Differences that are !same are returned

Returns:

the found child Difference, or null.

Throws:

MissingPropertyException - if the path is invalid

findPropertyInfo

public static PropertyInfo findPropertyInfo(java.lang.String type,
                            java.lang.String propPath,
                            java.lang.Class<? extends DBObjectProvider> proClz)

If the given property path is supported for the given object class this method returns the PropertyInfo associated with that property.

If you have a provider, it is better to use

   provider.getPropertyManager().findPropertyInfo
 

Parameters:

type - the object type

propPath - the property path

proClz - the provider class to filter the supported properties by

Returns:

a PropertyInfo for the property path if supported, else null

findPropertyInfo

public static PropertyInfo findPropertyInfo(java.lang.Class clz,
                            java.lang.String propPath,
                            java.lang.Class<? extends DBObjectProvider> proClz)

If the given property path is supported for the given object class this method returns the PropertyInfo associated with that property.

If you have a provider, it is better to use

   provider.getPropertyManager().findPropertyInfo
 

Parameters:

clz - the object class

propPath - the property path

proClz - the provider class to filter the supported properties by

Returns:

a PropertyInfo for the property path if supported, else null

See Also:

PropertyManager.findPropertyInfo(java.lang.Class,java.lang.String)

findPropertyInfo

public static PropertyInfo findPropertyInfo(java.lang.Class clz,
                            java.lang.String propPath,
                            DBObjectProvider pro)

If the given property path is supported for the given object class this method returns the PropertyInfo associated with that property.

If you have a provider, it is better to use

   provider.getPropertyManager().findPropertyInfo
 

which ultimately calls this method, but allows the provider implementation to apply additional logic.

Parameters:

clz - the object class

propPath - the property path

pro - the provider to filter the supported properties by

Returns:

a PropertyInfo for the property path if supported, else null

See Also:

PropertyManager.findPropertyInfo(java.lang.Class,java.lang.String)