oracle.javatools.db.sql
Class SelectObjectUsage

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

All Implemented Interfaces:

ChildDBObject, DBObject, FromObjectUsage, SQLFragment, Copyable, DynamicPropertySet

public class SelectObjectUsage
extends AbstractFromObjectUsage

Class that represents the usage of a SelectObject. This is used for a query to refer to the SelectObjects within its child query.

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

SelectObjectUsage()

SelectObjectUsage(DBObjectID selectID, DBObjectID fromID)

SelectObjectUsage(DBObjectID selectID, FromObject from)

SelectObjectUsage(SelectObject select, FromObject from)

Method Summary

DBObject	copyTo(DBObject target, DBObject copyParent, IDPolicy idPolicy) Internal copy method used by the API to perform copy operations.
protected void	copyToImpl(SelectObjectUsage target, DBObject copyParent, IDPolicy idPolicy)
boolean	equals(java.lang.Object obj)
protected boolean	equalsImpl(SelectObjectUsage obj)
java.lang.String	getColumnName() Returns the name of the underlying Column, SelectObject etc.
protected void	getReferenceIDsImpl(java.util.Collection<DBObjectID> refs) Used by the final getReferenceID() implementation.
SelectObject	getSelectObject() Deprecated. - use getSelectObjectID or resolveSelectObjectID
DBObjectID	getSelectObjectID()
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	setSelectObject(SelectObject used) Deprecated. - use setSelectObjectID
void	setSelectObjectID(DBObjectID selectID)

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, 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, 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

SelectObjectUsage

public SelectObjectUsage()

SelectObjectUsage

public SelectObjectUsage(SelectObject select,
                         FromObject from)

SelectObjectUsage

public SelectObjectUsage(DBObjectID selectID,
                         FromObject from)

SelectObjectUsage

public SelectObjectUsage(DBObjectID selectID,
                         DBObjectID fromID)

Method Detail

setSelectObject

@Deprecated
public void setSelectObject(SelectObject used)

Deprecated. - use setSelectObjectID

Parameters:

used -

getSelectObject

@Deprecated
public SelectObject getSelectObject()

Deprecated. - use getSelectObjectID or resolveSelectObjectID

setSelectObjectID

public void setSelectObjectID(DBObjectID selectID)

getSelectObjectID

public DBObjectID getSelectObjectID()

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.

Returns:

a string representing the SQL text for this object.

getColumnName

public java.lang.String getColumnName()

Description copied from interface: FromObjectUsage

Returns the name of the underlying Column, SelectObject etc. FromObjectUsages generally return FROM.COLUMN as their SQL text where FROM is the useable alias of the FromObject and COLUMN is a name. This method returns just the name without FROM.

copyTo

public DBObject copyTo(DBObject target,
                       DBObject copyParent,
                       IDPolicy idPolicy)

Description copied from class: AbstractDBObject

Internal copy method used by the API to perform copy operations. All objects must implement this method if they are instantiable objects. Abstract objects (e.g. Relation) must NOT implement this method. The implementation should delegate to the copyToImpl method to copy the actual properties.

This method does not fix internal reference ids on copy. That is done by the calling DBObject.copyTo(DBObject, IDPolicy) method.

Specified by:

copyTo in class AbstractDBObject

See Also:

DBObject.copyTo(java.lang.Object), DBObject.copyTo(DBObject, boolean), AbstractDBObject.copyToImpl(oracle.javatools.db.AbstractDBObject, oracle.javatools.db.DBObject, oracle.javatools.db.IDPolicy)

copyToImpl

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

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

equalsImpl

protected boolean equalsImpl(SelectObjectUsage obj)

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.