oracle.javatools.db.sql
Class ColumnKeywordUsage

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

All Implemented Interfaces:

ChildDBObject, DBObject, FromObjectUsage, SQLFragment, Copyable, DynamicPropertySet

Direct Known Subclasses:

AsteriskUsage

public class ColumnKeywordUsage
extends AbstractFromObjectUsage

A FromObjectUsage that has a keyword for the Column name, rather than an actual column. Examples: * or ROWID.

Nested Class Summary

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

AbstractDBObject.ChildSupport

Field Summary

static java.lang.String

ASTERISK

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

ColumnKeywordUsage()

ColumnKeywordUsage(java.lang.String keyword, 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(ColumnKeywordUsage target, DBObject copyParent, IDPolicy idPolicy)
boolean	equals(java.lang.Object obj)
protected boolean	equalsImpl(ColumnKeywordUsage other)
java.lang.String	getColumnName() Returns the name of the underlying Column, SelectObject etc.
java.lang.String	getSQLText() Return the SQL for this fragment.
void	setColumnName(java.lang.String name)

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

copyToImpl, equalsImpl, getFromObject, getFromObjectID, getReferenceIDsImpl, getSQLTextImpl, isQualified, replaceReferenceIDs, 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

Field Detail

ASTERISK

public static final java.lang.String ASTERISK

See Also:

Constant Field Values

Constructor Detail

ColumnKeywordUsage

public ColumnKeywordUsage()

ColumnKeywordUsage

public ColumnKeywordUsage(java.lang.String keyword,
                          FromObject from)

Method Detail

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.

setColumnName

public void setColumnName(java.lang.String name)

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.

copyToImpl

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

equalsImpl

protected boolean equalsImpl(ColumnKeywordUsage other)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

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)