oracle.javatools.db.sql
Class AbstractFromObjectUsage

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

All Implemented Interfaces:

ChildDBObject, DBObject, FromObjectUsage, SQLFragment, Copyable, DynamicPropertySet

Direct Known Subclasses:

AbstractDBObjectUsage, ColumnKeywordUsage, SelectObjectUsage

public abstract class AbstractFromObjectUsage
extends AbstractSQLFragment
implements FromObjectUsage

Abstract SQLFragment implementation of FromObjectUsage.

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	AbstractFromObjectUsage()
protected	AbstractFromObjectUsage(DBObjectID fromId)
protected	AbstractFromObjectUsage(FromObject from) Deprecated. - use ID based constructor instead

Method Summary

protected void	copyToImpl(AbstractFromObjectUsage target, DBObject copyParent, IDPolicy idPolicy)
protected boolean	equalsImpl(AbstractFromObjectUsage other)
FromObject	getFromObject() Deprecated. - use setFromObjectID() instead
DBObjectID	getFromObjectID() Returns the ID of the FromObject that this object is dependent on.
protected void	getReferenceIDsImpl(java.util.Collection<DBObjectID> refs) Used by the final getReferenceID() implementation.
protected java.lang.StringBuilder	getSQLTextImpl() Default implementation of getSQLText() which returns a StringBuilder containing the from object name (if there is one and we're qualified) DOT the column name.
boolean	isQualified() Gets wether this column usage should qualify itself with the alias from its FromObject.
boolean	replaceReferenceIDs(java.util.Map<DBObjectID,DBObjectID> idMap) Override in subclasses to replace reference IDs as appropriate.
FromObject	resolveFromObject() Convenience method for resolving the stored FROM object id.
protected FromObject	resolveFromObject(DBObjectID fromId)
void	setFromObject(FromObject from) Deprecated. - use setFromObjectID() instead
void	setFromObjectID(DBObjectID id) Sets the ID of the FromObject that this object is dependent on.
void	setQualified(boolean q) Sets wether this column usage should qualify itself with the alias from its FromObject.

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.FromObjectUsage

getColumnName

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

AbstractFromObjectUsage

protected AbstractFromObjectUsage()

AbstractFromObjectUsage

@Deprecated
protected AbstractFromObjectUsage(FromObject from)

Deprecated. - use ID based constructor instead

Parameters:

from -

AbstractFromObjectUsage

protected AbstractFromObjectUsage(DBObjectID fromId)

Parameters:

fromId -

Method Detail

setFromObject

@Deprecated
public void setFromObject(FromObject from)

Deprecated. - use setFromObjectID() instead

Sets the FromObject that this ColumnUsage is dependent on.

Specified by:

setFromObject in interface FromObjectUsage

getFromObject

@Deprecated
public FromObject getFromObject()

Deprecated. - use setFromObjectID() instead

Gets the FromObject that this ColumnUsage is dependent on.

Specified by:

getFromObject in interface FromObjectUsage

resolveFromObject

public FromObject resolveFromObject()

Convenience method for resolving the stored FROM object id. Catches any DBExceptions and writes them to the console. Do not use if you are interested in DBExceptions.

Specified by:

resolveFromObject in interface FromObjectUsage

Returns:

resolveFromObject

protected FromObject resolveFromObject(DBObjectID fromId)

setFromObjectID

public void setFromObjectID(DBObjectID id)

Description copied from interface: FromObjectUsage

Sets the ID of the FromObject that this object is dependent on.

Specified by:

setFromObjectID in interface FromObjectUsage

getFromObjectID

public DBObjectID getFromObjectID()

Description copied from interface: FromObjectUsage

Returns the ID of the FromObject that this object is dependent on.

Specified by:

getFromObjectID in interface FromObjectUsage

setQualified

public void setQualified(boolean q)

Sets wether this column usage should qualify itself with the alias from its FromObject. e.g. EMP.ENAME rather than ENAME

Specified by:

setQualified in interface FromObjectUsage

isQualified

public boolean isQualified()

Gets wether this column usage should qualify itself with the alias from its FromObject. e.g. EMP.ENAME rather than ENAME

Specified by:

isQualified in interface FromObjectUsage

copyToImpl

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

equalsImpl

protected boolean equalsImpl(AbstractFromObjectUsage other)

getSQLTextImpl

protected java.lang.StringBuilder getSQLTextImpl()

Default implementation of getSQLText() which returns a StringBuilder containing the from object name (if there is one and we're qualified) DOT the column name.

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.