oracle.javatools.db.sql

Class ColumnUsage

java.lang.Object

oracle.javatools.db.AbstractDBObject

oracle.javatools.db.AbstractBuildableObject

oracle.javatools.db.AbstractChildBuildableObject

oracle.javatools.db.sql.AbstractSQLFragment

oracle.javatools.db.sql.AbstractProviderUsageSQLFragment

oracle.javatools.db.sql.AbstractFromObjectUsage

oracle.javatools.db.sql.AbstractDBObjectUsage

oracle.javatools.db.sql.ColumnUsage

All Implemented Interfaces:

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

public class ColumnUsage
extends AbstractDBObjectUsage
implements SQLFragmentWithDatatype

SQL fragment that is a use of a Column. Used as a child of SelectObject or WhereObject.

Since:

10.1.3

Nested Class Summary

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

AbstractDBObject.ChildSupport, AbstractDBObject.ListenerSupport

Field Summary

Fields inherited from class oracle.javatools.db.sql.AbstractSQLFragment

COMMA, DEFAULT_SEPARATOR, EMPTY, EMPTY_ARRAY, INDENT, NEWLINE, SPACE

Fields inherited from interface oracle.javatools.db.sql.SQLFragment

CONNECTBY, FROM, GROUPBY, HAVING, MODEL, NOCYCLE, ORDERBY, ORDERSIBLINGSBY, PRIOR, SELECT, STARTWITH, TYPE, WHERE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

Constructors

Constructor and Description
ColumnUsage() Create an empty ColumnUsage.
ColumnUsage(DBObjectID colID) Create a ColumnUsage using the given Column ID to reference.
ColumnUsage(DBObjectID colID, FromObject from) Create a ColumnUsage using the given Column ID and FromObject to reference.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	getAttributes() Gets the list of attributes used.
java.lang.String	getColumnName() By default this returns the name of the DBObject we're using (externalized if a provider is available).
DBObjectID	getDataTypeID() Get the ID of the DataType of the SQLFragment.
java.lang.String	getSQLText() Returns the SQLText for the ColumnUsage.
boolean	isOuterJoin() Returns true if this column usage includes the outer join syntax for a where clause.
void	setAlwaysQuote(boolean boo)
void	setAttributes(java.lang.String[] attrs) Sets the list of attributes used (if any).
void	setColumnID(DBObjectID colID) Deprecated.
void	setOuterJoin(boolean oj) Sets whether this column usage contains the where clause syntax for an outer join.

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

getObjectID, setObjectID

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

findFragmentInQuery, getFromObject, getFromObjectID, getSQLTextImpl, isQualified, resolveFromObject, resolveFromObject, setFromObject, setFromObjectID, setQualified

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

areNamesEqual, copyToImpl, getDatabaseDescriptor, getExternalName, getInternalName, setProvider

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

appendToBuffer, argsToString, getStartOffset, getTextOrNull, getTextOrNull, getType, setStartOffset, surroundWithBrackets, surroundWithBrackets, toString

Methods inherited from class oracle.javatools.db.AbstractChildBuildableObject

setParent

Methods inherited from class oracle.javatools.db.AbstractBuildableObject

checkInit, checkInit, getOwnedObjectsImpl, getProperties, getReferenceIDsImpl, needsInitialization

Methods inherited from class oracle.javatools.db.AbstractDBObject

addObjectListener, addObjectListener, addObjectListener, changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, findOwnedObject, findParent, fireObjectUpdated, firePropertyChanged, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getParent, getProperty, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeObjectListener, removeObjectListener, removeObjectListener, removeOwnedObject, removeThisAsParent, replaceReferenceIDs, 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.sql.SQLFragment

getStartOffset

Methods inherited from interface oracle.javatools.db.ChildDBObject

getParent, setParent

Methods inherited from interface oracle.javatools.db.DBObject

addObjectListener, copyTo, copyTo, copyTo, equals, findOwnedObject, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getProperties, getReferenceIDs, getType, hashCode, removeObjectListener, removeOwnedObject, replaceReferenceIDs, setID, setName

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperty, getProperty, setProperties, setProperty

Methods inherited from interface oracle.javatools.db.ProviderUsage

setProvider

Constructor Detail

ColumnUsage

public ColumnUsage()

Create an empty ColumnUsage.

ColumnUsage

public ColumnUsage(DBObjectID colID)

Create a ColumnUsage using the given Column ID to reference.

ColumnUsage

public ColumnUsage(DBObjectID colID,
           FromObject from)

Create a ColumnUsage using the given Column ID and FromObject to reference.

Method Detail

setColumnID

@Deprecated
public void setColumnID(DBObjectID colID)

Deprecated.

getAttributes

public java.lang.String[] getAttributes()

Gets the list of attributes used. If the Column used has an object type datatype then it is possible to reference an attribute of that object type in the query directly. Furthermore if that attribute has an object type datatype we can recurse. The attribute list is currently returned as a String[] but we may move to a DBObjectID[] in the next release.

setAttributes

public void setAttributes(java.lang.String[] attrs)

Sets the list of attributes used (if any).

See Also:

getAttributes()

setOuterJoin

public void setOuterJoin(boolean oj)

Sets whether this column usage contains the where clause syntax for an outer join.

isOuterJoin

public boolean isOuterJoin()

Returns true if this column usage includes the outer join syntax for a where clause.

getSQLText

public java.lang.String getSQLText()

Returns the SQLText for the ColumnUsage. It uses the alias, or if not present the sql expression, for the FromObject, dot, the Column name.

Specified by:

getSQLText in interface SQLFragment

Returns:

a string representing the SQL text for this object.

setAlwaysQuote

public void setAlwaysQuote(boolean boo)

getColumnName

public java.lang.String getColumnName()

Description copied from class: AbstractDBObjectUsage

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

Specified by:

getColumnName in interface FromObjectUsage

Overrides:

getColumnName in class AbstractDBObjectUsage

getDataTypeID

public DBObjectID getDataTypeID()

Description copied from interface: SQLFragmentWithDatatype

Get the ID of the DataType of the SQLFragment. May be null if the DataType cannot be determined.

Specified by:

getDataTypeID in interface SQLFragmentWithDatatype