oracle.javatools.db.sql
Class AbstractSchemaObjectUsage

java.lang.Object
  oracle.javatools.db.AbstractDBObject
      oracle.javatools.db.sql.AbstractSQLFragment
          oracle.javatools.db.sql.AbstractSchemaObjectUsage

All Implemented Interfaces:

Copyable, DBObject, DBObjectUsage, DynamicPropertySet, SQLFragment

Direct Known Subclasses:

RelationUsage, SynonymUsage

public abstract class AbstractSchemaObjectUsage

extends AbstractSQLFragment

implements DBObjectUsage

Abstract class for usages that reference a SchemaObject (e.g. RelationUsage). This abstract implementation deals with getting the SQL text for a given ID.

Field Summary

protected DBObjectProvider

m_pro

Fields inherited from class oracle.javatools.db.sql.AbstractSQLFragment

EMPTY, EMPTY_ARRAY, NEWLINE, SPACE

Fields inherited from interface oracle.javatools.db.sql.SQLFragment

FROM, GROUPBY, HAVING, ORDERBY, SELECT, TYPE, WHERE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

AbstractSchemaObjectUsage()

AbstractSchemaObjectUsage(DBObjectID id)

Method Summary

protected void	copyToImpl(AbstractSchemaObjectUsage target)
protected boolean	equalsImpl(AbstractSchemaObjectUsage other)
DBObjectID	getObjectID() Gets the ID for the object being used by this fragment.
protected void	getReferenceIDsImpl(java.util.Collection refs) Used by the final getReferenceID() implementation.
java.lang.String	getSQLText() Return the SQL for this fragment.
protected boolean	isInDifferentSchema(SchemaObject obj)
boolean	replaceReferenceIDs(java.util.Map idMap) Replaces any reference ids (e.g.
void	setObjectID(DBObjectID id) Sets the ID for the object being used by this fragment.
void	setProvider(DBObjectProvider pro) Sets the provider this usage exists within.

Methods inherited from class oracle.javatools.db.sql.AbstractSQLFragment

appendToBuffer, changeParent, copyList, copyList, getChildren, getParent, getTextOrNull, getType, hashCode, removeParent, setParent, setParents, toString

Methods inherited from class oracle.javatools.db.AbstractDBObject

compareToImpl, copyToImpl, equalsImpl, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getOwnedObjectsImpl, getProperties, getProperty, getProperty, getReferenceIDs, setID, setName, setProperties, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.javatools.db.sql.SQLFragment

getChildren, getParent, setParent

Methods inherited from interface oracle.javatools.db.DBObject

copyTo, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getReferenceIDs, getType, setID, setName

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperties, getProperty, getProperty, setProperties, setProperty

Field Detail

m_pro

protected transient DBObjectProvider m_pro

Constructor Detail

AbstractSchemaObjectUsage

public AbstractSchemaObjectUsage()

AbstractSchemaObjectUsage

public AbstractSchemaObjectUsage(DBObjectID id)

Method Detail

setProvider

public void setProvider(DBObjectProvider pro)

Description copied from interface: DBObjectUsage

Sets the provider this usage exists within. The provider is used to convert names to external versions when creating the SQL for the fragment. Without this set names will not be quoted when appropriate.

Specified by:

setProvider in interface DBObjectUsage

setObjectID

public void setObjectID(DBObjectID id)

Description copied from interface: DBObjectUsage

Sets the ID for the object being used by this fragment.

Specified by:

setObjectID in interface DBObjectUsage

getObjectID

public DBObjectID getObjectID()

Description copied from interface: DBObjectUsage

Gets the ID for the object being used by this fragment.

Specified by:

getObjectID in interface DBObjectUsage

getSQLText

public java.lang.String getSQLText()

Description copied from interface: SQLFragment

Return the SQL for this fragment. This contains no validation - if the implementation is incomplete it will just return what it has. Error checking of fragments should be done using a SQLQueryBuilder.

Specified by:

getSQLText in interface SQLFragment

Returns:

a string representing the SQL text for this object.

equalsImpl

protected boolean equalsImpl(AbstractSchemaObjectUsage other)

copyToImpl

protected void copyToImpl(AbstractSchemaObjectUsage target)

isInDifferentSchema

protected boolean isInDifferentSchema(SchemaObject obj)

getReferenceIDsImpl

protected void getReferenceIDsImpl(java.util.Collection refs)

Description copied from class: AbstractDBObject

Used by the final getReferenceID() implementation. The list should not containnull values, or be null. Subclasses should start with super.getReferenceIDsImpl() and add to the returned list as appopriate.

Overrides:

getReferenceIDsImpl in class AbstractDBObject

replaceReferenceIDs

public boolean replaceReferenceIDs(java.util.Map idMap)

Description copied from interface: DBObject

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.

Specified by:

replaceReferenceIDs in interface DBObject

Overrides:

replaceReferenceIDs in class AbstractDBObject