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(AbstractDBObject target, DBObject copyParent, IDPolicy idPolicy) Implementation method for making a copy of this object.
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()
void	setObjectID(DBObjectID objectID) 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

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

findParent, getParent, getProperty, setProperty

Methods inherited from class oracle.javatools.db.AbstractDBObject

changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getOwnedObjectsImpl, getProperties, getProperty, getReferenceIDs, getReferenceIDsImpl, hashCode, includeOwnedObject, includesType, includesType, removeThisAsParent, replaceReferenceIDs, setID, setName, setProperties

Methods inherited from class java.lang.Object

clone, 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, replaceReferenceIDs, 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 objectID)

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

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.

copyToImpl

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

Description copied from class: AbstractDBObject

Implementation method for making a copy of this object. To add custom copyTo logic, a subclass must override this method (exactly), and must call back to the super implementation.

Overrides:

copyToImpl in class AbstractChildDBObject

Parameters:

target - the copy being created of this object

copyParent - if this object is being copied underneath a parent, this parameter is the copy of the parent of this object, which will therefore need to be the parent of the copy of this object.

idPolicy - the policy for copying the object's ID.