oracle.jdeveloper.cm.ds.db
Class DBObject

java.lang.Object
  oracle.jdeveloper.cm.ds.db.DBObject

All Implemented Interfaces:

Copyable

Direct Known Subclasses:

DBWorkArea, SchemaObject

public abstract class DBObject

extends java.lang.Object

implements Copyable

Base class for tables, nodes, constraints, etc.

Field Summary

static java.lang.String	ANONYMOUS_BLOCK Constant: ANONYMOUS_BLOCK
static java.lang.String	COLUMN Constant: Database Column
static java.lang.String	CONSTRAINT Constant: Constraint
static java.lang.String	FUNCTION Constant: FUNCTION
static java.lang.String	INDEX Constant: Database Index
static java.lang.String	PACKAGE_BODY Constant: PACKAGE_BODY
static java.lang.String	PACKAGE_SPEC Constant: PACKAGE_SPEC
static java.lang.String	PROCEDURE Constant: PROCEDURE
static java.lang.String	SEQUENCE Constant: Database Sequence
static java.lang.String	SYNONYM Constant: SYNONYM
static java.lang.String	TABLE Constant: Database Table
static java.lang.String	WORKAREA Constant: Database Work Area

Constructor Summary

DBObject()
Constructor

Method Summary

abstract java.lang.Object	copyTo(java.lang.Object target) Copies the internal state of this object to the specified copy.
protected void	copyToImpl(DBObject copy)
abstract boolean	equals(java.lang.Object target)
protected boolean	equalsImpl(DBObject target)
abstract java.util.Iterator	getChildren() If this object has subobjects (i.e.
java.lang.String	getName() returns the name of this object
abstract java.lang.String	getType() Returns the type of object this is.
void	setName(java.lang.String name) Sets the name of this object
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TABLE

public static final java.lang.String TABLE

Constant: Database Table

See Also:

Constant Field Values

WORKAREA

public static final java.lang.String WORKAREA

Constant: Database Work Area

See Also:

Constant Field Values

COLUMN

public static final java.lang.String COLUMN

Constant: Database Column

See Also:

Constant Field Values

SEQUENCE

public static final java.lang.String SEQUENCE

Constant: Database Sequence

See Also:

Constant Field Values

INDEX

public static final java.lang.String INDEX

Constant: Database Index

See Also:

Constant Field Values

PROCEDURE

public static final java.lang.String PROCEDURE

Constant: PROCEDURE

See Also:

Constant Field Values

FUNCTION

public static final java.lang.String FUNCTION

Constant: FUNCTION

See Also:

Constant Field Values

PACKAGE_SPEC

public static final java.lang.String PACKAGE_SPEC

Constant: PACKAGE_SPEC

See Also:

Constant Field Values

PACKAGE_BODY

public static final java.lang.String PACKAGE_BODY

Constant: PACKAGE_BODY

See Also:

Constant Field Values

ANONYMOUS_BLOCK

public static final java.lang.String ANONYMOUS_BLOCK

Constant: ANONYMOUS_BLOCK

See Also:

Constant Field Values

SYNONYM

public static final java.lang.String SYNONYM

Constant: SYNONYM

See Also:

Constant Field Values

CONSTRAINT

public static final java.lang.String CONSTRAINT

Constant: Constraint

See Also:

Constant Field Values

Constructor Detail

DBObject

public DBObject()

Constructor

Method Detail

copyTo

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

Description copied from interface: Copyable

Copies the internal state of this object to the specified copy. If copy is null, then this method should create a new instance of this class and proceed to copy the internal state to the newly created object. Generally, only the persistent state of the object should be copied, but whether or not it is appropriate to copy transient properties is at the discretion of the individual implementor.

Regardless of whether the copy occurs to an existing object or to a newly created object, the return value is object to which this object's state was copied.

There is a standard implementation pattern for the copyTo method that helps avoid problems that arise when a Copyable object is subclassed. The pattern is:

public Object copyTo( Object target )
{
final <this_class> copy =
target != null ? (<this_class>) target : new <this_class>();
copyToImpl( copy );
return copy;
} protected final void copyToImpl( <this_class> copy ) { super.copyToImpl( copy ); // if necessary // put code here for copying the properties of <this_class> }

The parameter passed into the copyToImpl method is the same type of this class. The responsibility of copyToImpl is to copy the state of this class through direct access of the fields. The copyToImpl method should not use getters and setters since these may be overridden, causing the state of this class to be incompletely copied.

Specified by:

copyTo in interface Copyable

Parameters:

target - The target object to which the state of this object should be copied. If target is null, then the copyTo method will return a new instance of this class.

Returns:

The object to which the state of this object was copied. If the target was non-null, then the return value is the same as the target object that was passed in; otherwise, the return value is a new instance of this class.

copyToImpl

protected void copyToImpl(DBObject copy)

equals

public abstract boolean equals(java.lang.Object target)

equalsImpl

protected boolean equalsImpl(DBObject target)

setName

public void setName(java.lang.String name)

Sets the name of this object

getName

public java.lang.String getName()

returns the name of this object

toString

public java.lang.String toString()

getType

public abstract java.lang.String getType()

Returns the type of object this is. The object type is defined as constants in DBObject

See Also:

TABLE, WORKAREA, COLUMN

getChildren

public abstract java.util.Iterator getChildren()

If this object has subobjects (i.e. a table contains columns), then this will return an Iterator on that list of children, otherwise it will return null.