oracle.javatools.db.sql

Class FunctionUsage

java.lang.Object

oracle.javatools.db.AbstractDBObject

oracle.javatools.db.AbstractBuildableObject

oracle.javatools.db.AbstractChildBuildableObject

oracle.javatools.db.sql.AbstractSQLFragment

oracle.javatools.db.sql.Operation

oracle.javatools.db.sql.FunctionUsage

All Implemented Interfaces:

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

Direct Known Subclasses:

XMLFunctionUsage

public class FunctionUsage
extends Operation
implements DBObjectUsage

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

AS, COMMA, DEFAULT_SEPARATOR, EMPTY, EMPTY_ARRAY, INDENT, LEFT_PAREN, NEWLINE, RIGHT_PAREN, 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
FunctionUsage()

Method Summary

Modifier and Type	Method and Description
protected void	copyToImpl(AbstractDBObject target, DBObject copyParent, IDPolicy idPolicy) Implementation method for making a copy of this object.
DBObjectID	getDataTypeID() Get the ID of the DataType of the SQLFragment.
java.lang.String	getFunction() Gets the function (text).
DBObjectID	getObjectID() Gets the ID for the object being used by this fragment.
protected java.lang.String	getOperatorText()
void	setObjectID(DBObjectID objectID) Sets the ID for the object being used by this fragment.
void	setProvider(DBObjectProvider pro) Sets the provider this usage exists within.
protected java.lang.String	surroundWithBrackets(java.lang.String text, boolean force) Surrounds the given text with brackets (parentheses).

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

addArgument, addArgument, addArguments, checkArgument, checkNewSize, equalsImpl, getArgumentCount, getArguments, getDistinctText, getSeparator, getSQLText, removeArgument, setArguments, setCommutative, setFunctionFormat, setSeparator

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

appendToBuffer, appendToBuffer, argsToString, getName, getStartOffset, getTextOrNull, getTextOrNull, getType, setStartOffset, 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, processPropertyChange, setID

Methods inherited from class oracle.javatools.db.AbstractDBObject

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

getSQLText, 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, getProperty, getProperty, getReferenceIDs, getType, hashCode, removeObjectListener, removeOwnedObject, replaceReferenceIDs, setID, setName, setProperties, setProperty

Constructor Detail

FunctionUsage

public FunctionUsage()

Method Detail

getOperatorText

protected java.lang.String getOperatorText()

Specified by:

getOperatorText in class Operation

getFunction

public java.lang.String getFunction()

Gets the function (text).

setObjectID

public void setObjectID(DBObjectID objectID)

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

setProvider

public void setProvider(DBObjectProvider pro)

Description copied from interface: ProviderUsage

Sets the provider this usage exists within. The provider is used internally for name conversion, id resolution etc.

Specified by:

setProvider in interface ProviderUsage

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

Overrides:

getDataTypeID in class Operation

surroundWithBrackets

protected java.lang.String surroundWithBrackets(java.lang.String text,
                                                boolean force)

Description copied from class: AbstractSQLFragment

Surrounds the given text with brackets (parentheses).

Overrides:

surroundWithBrackets in class AbstractSQLFragment

Parameters:

text - the text to surround

force - whether to force the surround (true), or instead assess whether the text is already surrounded (or contains an even number of sets of brackets) and therefore doesn't need any more (false).

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 Operation

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.