oracle.javatools.db

Interface DBObject

All Superinterfaces:

Copyable, DynamicPropertySet

All Known Subinterfaces:

AliasFragment, BinaryObject, ChildDBObject, DataType, DBObjectUsage, FromObjectUsage, JoinCondition, PlSqlSourceObject, SchemaObject, SourceObject, SQLFragment, SQLFragmentWithDatatype, SQLQueryOwner, SystemObject

All Known Implementing Classes:

AbstractAliasFragment, AbstractBuildableObject, AbstractChildBuildableObject, AbstractChildDBObject, AbstractDBObject, AbstractDBObjectUsage, AbstractFromObjectUsage, AbstractIncrementer, AbstractProviderUsageSQLFragment, AbstractSchemaObject, AbstractSchemaObjectUsage, AbstractSQLFragment, AbstractSQLQuery, AbstractSystemObject, Alias, ArithmeticOperation, AsteriskUsage, AutoExtendProperties, BuiltInFunction, BuiltInFunctionArgument, CaseStatement, CaseStatement.WhenThen, CheckConstraint, Column, ColumnConstraint, ColumnKeywordUsage, ColumnUsage, Comparison, Constraint, DatabaseLink, DataMiningFunction, DataMiningFunction.DataMiningArguments, DataMiningFunction.DataMiningCostValues, DataTypeAttribute, DataTypeSynonym, DataTypeUsage, DBObjectPlSqlFragment, Directory, ExpressionList, FileSpecification, FKConstraint, FKUsage, FromObject, Function, Function, FunctionUsage, GroupByExpression, GroupByObject, HierarchicalQueryObject, IdentityColumnProperties, Index, IndexObject, IndexPartition, Indextype, Java, JavaClass, JavaResource, JavaSource, JoinObject, LOBDescriptor, MaterializedView, MaterializedViewLog, ModelObject, ModelObject.CellAssignment, ModelObject.CellReferenceOptions, ModelObject.ModelColumnClauses, ModelObject.ModelRulesCellAssignmentExpr, ModelObject.ModelRulesClause, ModelObject.MultiColumnForLoop, ModelObject.ReferenceModel, ModelObject.SingleColumnForLoop, NonDeclarativeSQLQuery, OnJoinCondition, Operation, OracleColumnProperties, OracleExternalTableProperties, OracleExternalTableProperties.LocationSpecifier, OracleIndexOrganizedTableProperties, OracleIndexPartitions, OracleNestedTableProperties, OracleSQLQuery, OracleStorageProperties, OracleTablePartitions, OracleTableProperties, OracleTablespaceProperties, OrderByObject, Package, PackageBody, PKConstraint, PlSqlAttribute, PlSqlBlock, PlSqlCodeFragment, PlSqlComment, PlSqlDatatype, PlSqlDatum, PlSqlMethod, PlSqlParameter, PlSqlReference, PlSqlSchemaObject, PlSqlSchemaObjectBody, PlSqlSchemaObjectSpec, PlSqlSubProgram, PlSqlUsage, PlSqlVariable, PredefinedDataType, PredefinedDataTypeUsage, Procedure, RecycledObject, Relation, RelationUsage, Schema, SelectObject, SelectObjectUsage, Sequence, SequenceUsage, SetOperation, SetOperator, SimpleSQLFragment, SQLQuery, Synonym, SynonymUsage, Table, TablePartition, Tablespace, Trigger, Type, TypeBody, UniqueConstraint, UserDataType, UsingJoinCondition, View, ViewColumn, WhereObject, WindowFunction, WindowFunction.WindowFunctionBound, XMLFunctionUsage, XMLSchema, XMLSchemaElement, XMLTypeColumnProperties

public interface DBObject
extends Copyable, DynamicPropertySet

Base interface for all database objects. A database object is not assumed to exist in a database; rather, it is just something that could exist in a database. Commonly used implementations in the api are Table, Column etc.

Since:

9.0.2

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMMENT The comment property.

Method Summary

Methods

Modifier and Type	Method and Description
void	addObjectListener(DBObjectListener list) Attaches a listener to this object to listen for change events.
DBObject	copyTo(DBObject target, boolean temporaryCopy) Copies the state of this object to another instance.
DBObject	copyTo(DBObject target, IDPolicy idPolicy) Copies the state of this object to another instance.
java.lang.Object	copyTo(java.lang.Object target) Implementation of the Copyable interface that copies the state of this DBObject to another instance.
boolean	equals(java.lang.Object obj) Returns true if this object is "equal" to the given object.
DBObject	findOwnedObject(DBObjectID id) Returns a child of this object that has the given ID.
DBObject	findOwnedObject(DBObjectID id, boolean strict) Returns a child of this object that has the given ID.
DBObject	findOwnedObject(java.lang.String type, java.lang.String name) Returns an object owned by this object with given name and type, if one exists.
DBObjectID	getID() Retrieves the object ID associated with this object.
java.lang.String	getName() Retrieves the name of this object.
DBObject[]	getOwnedObjects() Returns the objects owned by this object.
DBObject[]	getOwnedObjects(java.lang.String... type) Returns the objects owned by this object of the given type.
DBObject	getParent() Returns the parent of this object, if one exists.
java.util.Map<java.lang.String,java.lang.Object>	getProperties() Gets the property map that stores all the property information for this object.
DBObjectID[]	getReferenceIDs() Returns all the IDs that this object has as properties that reference other DBObjects.
java.lang.String	getType() Returns the type of this object.
int	hashCode() Returns a hashCode value for the object.
void	removeObjectListener(DBObjectListener list) Removes the given listener from the list of registered listeners for this object.
boolean	removeOwnedObject(DBObject child) Removes the given child from this object.
boolean	replaceReferenceIDs(java.util.Map<? extends DBObjectID,? extends DBObjectID> oldToNew) Replaces any reference ids (e.g.
void	setID(DBObjectID id) Sets the object ID associated with this object.
void	setName(java.lang.String name) Sets the name of this object.

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperty, getProperty, setProperties, setProperty

Field Detail

COMMENT

static final java.lang.String COMMENT

The comment property.

See Also:

Constant Field Values

Method Detail

copyTo

java.lang.Object copyTo(java.lang.Object target)

Implementation of the Copyable interface that copies the state of this DBObject to another instance. If null is specified for the target, a new instance will be created.

The entire state of the object will be copied, with a few exceptions. In particular, any observers registered will NOT be copied. In cases where this instance contains child DBObjects, new instances of those children will be created, and the state copied to them. The copy will thus contain its own unique state; after making the copy, changing one instance will not cause any changes to occur to the copy. The properties will be copied; however, copies will not be made of the values referenced by the properties - thus, the copy will refer to the same instance as the original. Child objects that are copied will still point to the original parent; it is the responsibility of a copied parent to update the parent of copies of its children point to the copy of itself.

If the object, or any child object has an ID set, the equivalent object in the copy will be given a TemporaryObjectID that does not reference back to the original object. See copyTo(DBObject, boolean) for details.

Specified by:

copyTo in interface Copyable

Parameters:

target - The object to copy to. If target is null, a new instance will be created, and the state will be copied to that object.

Returns:

the copy.

Throws:

java.lang.ClassCastException - if the target is not null and cannot be downcast to the type represented by this object.

See Also:

copyTo(DBObject, boolean)

copyTo

DBObject copyTo(DBObject target,
              boolean temporaryCopy)

Copies the state of this object to another instance. If null is specified for the target, a new instance will be created.

The entire state of the object will be copied. In cases where this instance contains child DBObjects, new instances of those children will be created, and the state copied to them. The copy will thus contain its own unique state; after making the copy, changing one instance will not cause any changes to occur to the copy. The properties will be copied; however, copies will not be made of the values referenced by the properties - thus, the copy will refer to the same instance as the original.

The includeID parameter governs what happens to any ids (on this object, or on any children). If true a TemporaryObjectID will be assigned to the copy of any DBObject, that points back to the original object. If false a TemporaryObjectID will be assigned to the copy of any DBObject that already has an ID, but it will not point back to the original.

Parameters:

target - The object to copy to. If target is null, a new instance will be created, and the state will be copied to that object.

temporaryCopy - Whether to include a TemporaryObjectID that points back to the original for every object.

Returns:

the copy.

Throws:

java.lang.ClassCastException - if the target is not null and cannot be downcast to the type represented by this object.

Since:

11.0

See Also:

TemporaryObjectID, copyTo(java.lang.Object)

copyTo

DBObject copyTo(DBObject target,
              IDPolicy idPolicy)

Copies the state of this object to another instance. If null is specified for the target, a new instance will be created.

The entire state of the object will be copied. In cases where this instance contains child DBObjects, new instances of those children will be created, and the state copied to them. The copy will thus contain its own unique state; after making the copy, changing one instance will not cause any changes to occur to the copy. The properties will be copied; however, copies will not be made of the values referenced by the properties - thus, the copy will refer to the same instance as the original.

The idPolicy is used to control the IDs set on all objects in the copy.

Parameters:

target - The object to copy to. If target is null, a new instance will be created, and the state will be copied to that object.

idPolicy - The policy for the IDs set in the copy.

Returns:

the copy.

Throws:

java.lang.ClassCastException - if the target is not null and cannot be downcast to the type represented by this object.

Since:

11.0

See Also:

TemporaryObjectID, copyTo(java.lang.Object), copyTo(DBObject, boolean)

setName

void setName(java.lang.String name)

Sets the name of this object.

Parameters:

name - a string containing the new name for this object.

getName

java.lang.String getName()

Retrieves the name of this object.

Returns:

a string containing the name of this object.

getID

DBObjectID getID()

Retrieves the object ID associated with this object.

Returns:

the DBObjectID associated with this object

setID

void setID(DBObjectID id)

Sets the object ID associated with this object. Note that the ID should only be set at most once. Implementations should ensure that the id is not reset.

Parameters:

id - the DBObjectID to be associated with this object

Throws:

java.lang.IllegalStateException - if the ID is already set

getType

java.lang.String getType()

Returns the type of this object. Valid types include things like tables, views, synonyms, and columns.

Returns:

a string describing the type of object.

getOwnedObjects

DBObject[] getOwnedObjects()

Returns the objects owned by this object.

• The order of this array is not guarenteed, i.e. IT CANNOT BE RELIED UPON TO RETURN THE CHILDREN IN TYPE, NAME OR ANY OTHER ORDER.
• Editing the returned array will not effect this object.
• Editing the objects contained in the returned array will effect this object's children - use the updateObject() policies from the provider.

Schema's will not return the SchemaObjects contained within them through this method. Use the DBObjectProvider to list those objects.

If this object supports lazy loading, calling this will fully load the object.

This method should not return null - whether children are not supported on this object, or the object supports children and has none an empty array should be returned.

Returns:

the owned objects of this object

Since:

10.1.3

getOwnedObjects

DBObject[] getOwnedObjects(java.lang.String... type)

Returns the objects owned by this object of the given type.

• The order of this array is not guarenteed, i.e. IT CANNOT BE RELIED UPON TO RETURN THE CHILDREN IN TYPE, NAME OR ANY OTHER ORDER.
• Editing the returned array will not effect this object.
• Editing the objects contained in the returned array will effect this object's children - use the updateObject() policies from the provider.

Schema's will not return the SchemaObjects contained within them through this method. Use the DBObjectProvider to list those objects.

If this object supports lazy loading, calling this will fully load the object.

This method should not return null - whether children are not supported on this object, or the object supports children and has none an empty array should be returned.

Parameters:

types - the DBObject type(s) for the children to be returned (e.g. Column.TYPE)

Returns:

the owned objects of the given types

Since:

10.1.3

findOwnedObject

DBObject findOwnedObject(java.lang.String type,
                       java.lang.String name)

Returns an object owned by this object with given name and type, if one exists. Otherwise returns null.

The method does not recurse to look for children of children.

If this object supports lazy loading, calling this will fully load the object.

This will not find SchemaObjects in a Schema, as in the API the Schema -> SchemaObject relationship is not an owner -> owned object relationship.

Parameters:

type - the DBObject type for the child to be returned (e.g. Column.TYPE)

name - the name of the DBObject to be returned

Returns:

the appropriate child object, if one exists.

Since:

10.1.3

findOwnedObject

DBObject findOwnedObject(DBObjectID id)

Returns a child of this object that has the given ID. The child is located by comparing IDs, not by calling resolveID() and is therefore the quickest way to locate a DBObject if you know its parent.

This will do a strict comparison of the DBObjectIDs when searching.

The method does not recurse to look for children of children.

This will not find SchemaObjects in a Schema, as in the API the Schema -> SchemaObject relationship is not an owner -> owned object relationship.

Parameters:

id - the id to look for

Returns:

a child object found with that id or null if no child is found

Since:

11

See Also:

findOwnedObject(DBObjectID,boolean)

findOwnedObject

DBObject findOwnedObject(DBObjectID id,
                       boolean strict)

Returns a child of this object that has the given ID. The child is located by comparing IDs, not by calling resolveID() and is therefore the quickest way to locate a DBObject if you know its parent.

Note: an unstrict comparison can be time consuming, only request it if you need it (i.e. you are searching using a DBObjectID that did not originate in this object's heirarchy).

The method does not recurse to look for children of children.

This will not find SchemaObjects in a Schema, as in the API the Schema -> SchemaObject relationship is not an owner -> owned object relationship.

Parameters:

id - the id to look for

strict - whether to stricly compare IDs or not

Returns:

a child object found with a matching id, or null if no child is found

Since:

12

See Also:

DBObjectID.equals(DBObjectID,boolean)

removeOwnedObject

boolean removeOwnedObject(DBObject child)

Removes the given child from this object. For example this can be used to remove a Column from a Table. The Object instance passed in must be the exact instance held as a property, no name/type/id matching will be done.

This will not remove SchemaObjects from a Schema, as in the API the Schema -> SchemaObject relationship is not an owner -> owned object relationship.

Parameters:

child - a DBObject instance held as a property on this DBObject that is to be removed.

Returns:

true if the child was found and successfully removed.

getParent

DBObject getParent()

Returns the parent of this object, if one exists. This does not return the Schema for a SchemaObject. Schema's are not considered part of the ownership parent tree.

Since:

10.1.3

getReferenceIDs

DBObjectID[] getReferenceIDs()

Returns all the IDs that this object has as properties that reference other DBObjects. For example a FKConstraint references a UniqueConstraint via a DBObjectID and that would be included in what is returned by this method.

If this object supports lazy loading, calling this will fully load the object.

Will not return null.

Returns:

all property values that are DBObjectIDs.

Since:

10.1.3

replaceReferenceIDs

boolean replaceReferenceIDs(java.util.Map<? extends DBObjectID,? extends DBObjectID> oldToNew)

Replaces any reference ids (e.g. "reference id" on an FKConstraint) on the object with new versions of that id according to the entries in the Map. This can be used to hook up old and new ids between copies of the same object, or to update a referencing id after an object's id has changed.

If this object supports lazy loading, calling this will fully load the object.

Parameters:

oldToNew - key = old DBObjectID, value = new DBObjectID

Returns:

true if any ids were replaced.

Since:

10.1.3

addObjectListener

void addObjectListener(DBObjectListener list)

Attaches a listener to this object to listen for change events. The same listener implementation cannot be registered more than once. i.e. once added, subsequent attempts to add the same listener again will do nothing.

Parameters:

list - the listener to add to this object

removeObjectListener

void removeObjectListener(DBObjectListener list)

Removes the given listener from the list of registered listeners for this object.

Parameters:

list - the listener to remove

getProperties

java.util.Map<java.lang.String,java.lang.Object> getProperties()

Gets the property map that stores all the property information for this object.

Specified by:

getProperties in interface DynamicPropertySet

Returns:

the property-value mappings for this object.

equals

boolean equals(java.lang.Object obj)

Returns true if this object is "equal" to the given object. "Equal" for DBObjects means that they have equal property values (not including the DBObjectID which is not compared). Comparing property values for equality can be time consuming, and when the object comes from a Database this can also hit the underlying database Connection.

For this reason care should be taken putting DBObjects in to Collection or Map implementations, because any comparison using equals will be slow.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the other object to compare for equality.

Returns:

true if obj has the same DBObjectID and property values as this object.

See Also:

DBObjectSet, DBObjectMap

hashCode

int hashCode()

Returns a hashCode value for the object. The standard implementation for a DBObject is to return a hash of the object's type, as that is the only property of a DBObject that is immutable.

Combined with the equals implementation, this means that lookup in a HashMap will not be performant, and in general DBObjects should not be put in a HashMap, HashSet etc.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code for this object.

See Also:

DBObjectSet, DBObjectMap