oracle.javatools.db.property

Annotation Type References

@Retention(value=RUNTIME)
@Target(value={FIELD,METHOD})
public @interface References

Provides extra metadata about a reference property (i.e. return value is a DBObjectID). To use, annotate the get method of the property on the DBObject.

Since:

11.1.1.1.0

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
CascadeAction	cascade Defines the behaviour when cascade is being performed and the object being referenced is deleted.
boolean	internal If true, this indicates that the object being referenced is internal to the owning SystemObject.
java.lang.String[]	types Gets any restriction on the types of object that can be referenced by this property's ID.
java.lang.Class<? extends DBObject>	value Gets the expected class of object that resolving the ID will give.

Element Detail

value

public abstract java.lang.Class<? extends DBObject> value

Gets the expected class of object that resolving the ID will give. The default is DBObject.class - i.e. anything.

Default:

oracle.javatools.db.DBObject.class

types

public abstract java.lang.String[] types

Gets any restriction on the types of object that can be referenced by this property's ID. This is a filter in addition to value() so the types listed here should be a subset of the types of known subclasses of the value class. For example, if value returned SystemObject.class this could return {Sequence.TYPE, Synonym.TYPE} to show that only sequences and synonyms can be referenced.

By default an empty array is returned which signifies no additional filtering over the value class.

Default:

{}

internal

public abstract boolean internal

If true, this indicates that the object being referenced is internal to the owning SystemObject. For example Columns on a Constraint are within the owning Table.

Default:

false

cascade

public abstract CascadeAction cascade

Defines the behaviour when cascade is being performed and the object being referenced is deleted.

• NONE means the object is unchanged
• UPDATE means the property on the object will be set to null. If the property is a list of ids, it will be removed from the list (possibly leaving the list empty).
• DELETE means the object will be deleted. If the property is a list of ids the reference being deleted will be removed from the list first, and if the list is empty after that the object will be deleted.

The default is UPDATE.

Default:

oracle.javatools.db.refactoring.CascadeAction.UPDATE