oracle.javatools.db.sql

Class AbstractSchemaObjectUsage

java.lang.Object

oracle.javatools.db.AbstractDBObject

oracle.javatools.db.AbstractBuildableObject

oracle.javatools.db.AbstractChildBuildableObject

oracle.javatools.db.sql.AbstractSQLFragment

oracle.javatools.db.sql.AbstractSchemaObjectUsage

All Implemented Interfaces:

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

Direct Known Subclasses:

RelationUsage, SynonymUsage

public abstract class AbstractSchemaObjectUsage
extends AbstractSQLFragment
implements DBObjectUsage

Abstract class for usages that reference a SchemaObject (e.g. RelationUsage). This abstract implementation deals with getting the SQL text for a given ID.

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
AbstractSchemaObjectUsage()
AbstractSchemaObjectUsage(DBObjectID id)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	copyToImpl(AbstractDBObject target, DBObject copyParent, IDPolicy idPolicy) Implementation method for making a copy of this object.
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 for the object being used by this fragment.
java.lang.String	getSQLText() Return the SQL for this fragment.
void	setObjectID(DBObjectID id) Sets the ID for the object being used by this fragment.
void	setProvider(DBObjectProvider pro) Sets the provider this usage exists within.

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, equalsImpl, fireObjectUpdated, getOwnedObjectsImpl, getProperties, getReferenceIDsImpl, needsInitialization

Methods inherited from class oracle.javatools.db.AbstractDBObject

addObjectListener, addObjectListener, addObjectListener, changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, findOwnedObject, findOwnedObject, findOwnedObject, findOwnedObject, findParent, 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, findOwnedObject, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getProperties, getReferenceIDs, getType, removeObjectListener, removeOwnedObject, replaceReferenceIDs, setID, setName

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperty, getProperty, setProperties, setProperty

Constructor Detail

AbstractSchemaObjectUsage

public AbstractSchemaObjectUsage()

AbstractSchemaObjectUsage

public AbstractSchemaObjectUsage(DBObjectID id)

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

setObjectID

public void setObjectID(DBObjectID id)

Description copied from interface: DBObjectUsage

Sets the ID for the object being used by this fragment.

Specified by:

setObjectID in interface DBObjectUsage

getObjectID

public DBObjectID getObjectID()

Description copied from interface: DBObjectUsage

Gets the ID for the object being used by this fragment.

Specified by:

getObjectID in interface DBObjectUsage

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.

Specified by:

getSQLText in interface SQLFragment

Returns:

a string representing the SQL text for this object.

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 AbstractBuildableObject

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.