oracle.javatools.db.sql
Class AbstractSchemaObjectUsage

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

All Implemented Interfaces:

ChildDBObject, DBObject, ProviderUsage, DBObjectUsage, SQLFragment, Copyable, DynamicPropertySet

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.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject

AbstractDBObject.ChildSupport

Field Summary

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

DEFAULT_SEPARATOR, EMPTY, EMPTY_ARRAY, NEWLINE, SPACE

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

CONNECTBY, FROM, GROUPBY, HAVING, NOCYCLE, ORDERBY, SELECT, STARTWITH, TYPE, WHERE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

AbstractSchemaObjectUsage()

AbstractSchemaObjectUsage(DBObjectID id)

Method Summary

protected void	copyToImpl(AbstractSchemaObjectUsage target, DBObject copyParent, IDPolicy idPolicy)
protected boolean	equalsImpl(AbstractSchemaObjectUsage other)
protected java.lang.String	getExternalName(java.lang.String name) If this object has a provider associated with it, the given name is returned in "externalised" form.
DBObjectID	getObjectID() Gets the ID for the object being used by this fragment.
protected void	getReferenceIDsImpl(java.util.Collection<DBObjectID> refs) Used by the final getReferenceID() implementation.
java.lang.String	getSQLText() Return the SQL for this fragment.
boolean	replaceReferenceIDs(java.util.Map<DBObjectID,DBObjectID> idMap) Override in subclasses to replace reference IDs as appropriate.
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, argsToString, getTextOrNull, getTextOrNull, getType, setParent, surroundWithBrackets, surroundWithBrackets, toString

Methods inherited from class oracle.javatools.db.AbstractChildDBObject

copyToImpl, findParent, getParent

Methods inherited from class oracle.javatools.db.AbstractDBObject

changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, copyToImpl, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getOwnedObjectsImpl, getProperties, getProperty, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeThisAsParent, 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.ChildDBObject

getParent, setParent

Methods inherited from interface oracle.javatools.db.DBObject

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

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperties, getProperty, getProperty, setProperties, setProperty

Constructor Detail

AbstractSchemaObjectUsage

public AbstractSchemaObjectUsage()

AbstractSchemaObjectUsage

public AbstractSchemaObjectUsage(DBObjectID id)

Method Detail

setProvider

public void setProvider(DBObjectProvider pro)

Description copied from interface: ProviderUsage

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 ProviderUsage

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,
                          DBObject copyParent,
                          IDPolicy idPolicy)

getReferenceIDsImpl

protected void getReferenceIDsImpl(java.util.Collection<DBObjectID> refs)

Description copied from class: AbstractDBObject

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

Overrides:

getReferenceIDsImpl in class AbstractDBObject

Parameters:

refs - the collection of ids this object references

replaceReferenceIDs

public boolean replaceReferenceIDs(java.util.Map<DBObjectID,DBObjectID> idMap)

Description copied from class: AbstractDBObject

Override in subclasses to replace reference IDs as appropriate. Always call super in the overridden implementation to make sure the default implementation (which checks the property map) is called.

Specified by:

replaceReferenceIDs in interface DBObject

Overrides:

replaceReferenceIDs in class AbstractDBObject

Parameters:

idMap - key = old DBObjectID, value = new DBObjectID

Returns:

true if any ids were replaced.

getExternalName

protected java.lang.String getExternalName(java.lang.String name)

If this object has a provider associated with it, the given name is returned in "externalised" form.