oracle.javatools.db

Class CascadeManager.LookupCriteria

java.lang.Object

oracle.javatools.db.CascadeManager.LookupCriteria

Enclosing class:

CascadeManager

public static class CascadeManager.LookupCriteria
extends java.lang.Object

Used to customise the lookup of references or referers through the CascadeManager.

Since:

12

Constructor Summary

Constructors

Constructor and Description
CascadeManager.LookupCriteria()

Method Summary

Methods

Modifier and Type	Method and Description
<T extends DBObject> boolean	addIfRequired(T obj, java.util.Collection<? super T> objs) Adds an object to the given collection if it is allowed by this lookup.
<T extends DBObjectID> boolean	addIfRequired(T id, java.util.Collection<? super T> ids) Adds an id to the given collection if its type is allowed by this lookup.
java.lang.String[]	getIgnoredProperties() Gets the properties that this lookup should ignore on all objects.
java.lang.String[]	getTypes() Gets the object types that this lookup should be restricted to.
boolean	isIgnoredProperty(java.lang.String prop) Tests whether the given property should be ignored in the lookup.
boolean	isRecurse() Gets whether the lookup should recurse on to found objects.
boolean	isRequiredType(java.lang.String type) Tests whether the given object type is required by this criteria.
void	setIgnoredProperties(java.lang.String... props) Sets the property names that this lookup will ignore on all objects.
void	setRecurse(boolean recurse) Sets whether the lookup should recurse - i.e.
void	setTypes(java.lang.String... types) Sets the object types that we require in the lookup.

Methods inherited from class java.lang.Object

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

Constructor Detail

CascadeManager.LookupCriteria

public CascadeManager.LookupCriteria()

Method Detail

setRecurse

public void setRecurse(boolean recurse)

Sets whether the lookup should recurse - i.e. when it finds an object it should then perform the same lookup on that object as well.

Parameters:

recurse - whether to recurse

isRecurse

public boolean isRecurse()

Gets whether the lookup should recurse on to found objects.

Returns:

whether to recurse

setTypes

public void setTypes(java.lang.String... types)

Sets the object types that we require in the lookup.

Parameters:

types - restriction on the object types we're interested in finding.

getTypes

public java.lang.String[] getTypes()

Gets the object types that this lookup should be restricted to.

Returns:

any restriction on the object types

isRequiredType

public boolean isRequiredType(java.lang.String type)

Tests whether the given object type is required by this criteria.

Returns:

true if the object type should be included in a lookup.

addIfRequired

public <T extends DBObject> boolean addIfRequired(T obj,
                                         java.util.Collection<? super T> objs)

Adds an object to the given collection if it is allowed by this lookup.

Parameters:

obj - the object to add, if required

objs - the collection of objects that we've found in the lookup

Returns:

true if the object was added, false if the object wasn't required or add on the Collection returned false (e.g. already in Set)

addIfRequired

public <T extends DBObjectID> boolean addIfRequired(T id,
                                           java.util.Collection<? super T> ids)

Adds an id to the given collection if its type is allowed by this lookup.

Parameters:

id - the id to add, if required

ids - the collection of ids that we've found in the lookup

Returns:

true if the id was added, false if the id wasn't required, or add on the Collection returned false (e.g. already in Set)

setIgnoredProperties

public void setIgnoredProperties(java.lang.String... props)

Sets the property names that this lookup will ignore on all objects. The value for any property in this list will not be included when searching for dependencies. The array instance passed in to this method will be sorted.

This criteria only works for a "referenced objects" lookup, and not for a "referers" lookup.

Setting a property that is a child object property (e.g. constraints) will ignore all references from any child object underneath that property on all objects.

Parameters:

props - the properties to ignore during the lookup

getIgnoredProperties

public java.lang.String[] getIgnoredProperties()

Gets the properties that this lookup should ignore on all objects.

Returns:

the properties to ignore during the lookup.

isIgnoredProperty

public boolean isIgnoredProperty(java.lang.String prop)

Tests whether the given property should be ignored in the lookup.

Parameters:

prop - the property to test

Returns:

true if the property should be ignored in the lookup