oracle.javatools.db.sql
Class AbstractDBObjectUsage

java.lang.Object
  oracle.javatools.db.AbstractDBObject
      oracle.javatools.db.AbstractChildDBObject
          oracle.javatools.db.sql.AbstractSQLFragment
              oracle.javatools.db.sql.AbstractFromObjectUsage
                  oracle.javatools.db.sql.AbstractDBObjectUsage

All Implemented Interfaces:

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

Direct Known Subclasses:

ColumnUsage, PlSqlUsage

public abstract class AbstractDBObjectUsage
extends AbstractFromObjectUsage
implements DBObjectUsage

Abstract implementation for a SQLFragment that uses another DBObject (e.g a Column) through a FromObject in the query.

Since:

11

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

protected	AbstractDBObjectUsage()
protected	AbstractDBObjectUsage(DBObjectID id, DBObjectID fromID)

Method Summary

protected void	copyToImpl(AbstractDBObjectUsage target, DBObject copyParent, IDPolicy idPolicy)
protected boolean	equalsImpl(AbstractDBObjectUsage other)
java.lang.String	getColumnName() By default this returns the name of the DBObject we're using (externalized if a provider is available).
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 of the DBObject (e.g.
protected DBObjectProvider	getProvider()
protected void	getReferenceIDsImpl(java.util.Collection<DBObjectID> refs) Used by the final getReferenceID() implementation.
boolean	replaceReferenceIDs(java.util.Map<DBObjectID,DBObjectID> idMap) Override in subclasses to replace reference IDs as appropriate.
void	setObjectID(DBObjectID id) Sets the id of the DBObject (e.g.
void	setProvider(DBObjectProvider pro) Sets the provider this usage exists within.

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

copyToImpl, equalsImpl, getFromObject, getFromObjectID, getSQLTextImpl, isQualified, resolveFromObject, resolveFromObject, setFromObject, setFromObjectID, setQualified

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.sql.SQLFragment

getSQLText

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

AbstractDBObjectUsage

protected AbstractDBObjectUsage()

AbstractDBObjectUsage

protected AbstractDBObjectUsage(DBObjectID id,
                                DBObjectID fromID)

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

getProvider

protected DBObjectProvider getProvider()

setObjectID

public void setObjectID(DBObjectID id)

Sets the id of the DBObject (e.g. Column) used.

Specified by:

setObjectID in interface DBObjectUsage

getObjectID

public DBObjectID getObjectID()

Gets the id of the DBObject (e.g. Column) used.

Specified by:

getObjectID in interface DBObjectUsage

copyToImpl

protected void copyToImpl(AbstractDBObjectUsage target,
                          DBObject copyParent,
                          IDPolicy idPolicy)

equalsImpl

protected boolean equalsImpl(AbstractDBObjectUsage other)

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 AbstractFromObjectUsage

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 AbstractFromObjectUsage

Parameters:

idMap - key = old DBObjectID, value = new DBObjectID

Returns:

true if any ids were replaced.

getColumnName

public java.lang.String getColumnName()

By default this returns the name of the DBObject we're using (externalized if a provider is available).

Specified by:

getColumnName in interface FromObjectUsage

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.