oracle.javatools.db.sql

Class Operation

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

All Implemented Interfaces:

ChildDBObject, DBObject, SQLFragment, SQLFragmentWithDatatype, Copyable

Direct Known Subclasses:

ArithmeticOperation, Comparison, ConnectByRoot, DataMiningFunction, ExpressionList, Function, FunctionUsage, GroupByExpression, SetOperation, SetOperator, WhereObject

public abstract class Operation
extends AbstractSQLFragment
implements SQLFragmentWithDatatype

Abstract class for operations. Consists of a set of arguments and an operation text. The operator can be of a "function format"
OPERATION(arg1, arg2, arg3 ...)
or not
arg1 OPERATION arg2 OPERATION arg3 ...

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

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
Operation()
Operation(SQLFragment[] args)

Method Summary

Modifier and Type	Method and Description
void	addArgument(int index, SQLFragment expression)
void	addArgument(SQLFragment expression)
void	addArguments(SQLFragment[] expressions)
protected void	checkArgument(java.util.List<SQLFragment> existing, SQLFragment add) If this returns true the Operation checks that the type of all arguments is the same.
protected void	checkNewSize(int proposedSize) Override for operations that have specific size restrictions.
protected void	copyToImpl(AbstractDBObject target, DBObject copyParent, IDPolicy idPolicy) Implementation method for making a copy of this object.
protected boolean	equalsImpl(AbstractDBObject other) Equals implementation for testing equality with another AbstractDBObject.
int	getArgumentCount() Returns the number of arguments stored.
SQLFragment[]	getArguments() Returns the arguments stored in this function.
DBObjectID	getDataTypeID() Get the ID of the DataType of the SQLFragment.
protected java.lang.String	getDistinctText() Override this for aggregate functions which may take a DISTINCT/UNIQUE/ALL qualifier.
protected abstract java.lang.String	getOperatorText()
protected java.lang.String	getSeparator()
java.lang.String	getSQLText() Returns the complete SQL representation for this Function fragment.
boolean	removeArgument(SQLFragment expression)
void	setArguments(SQLFragment[] arguments) Sets the arguments for this function.
protected void	setCommutative(boolean boo) Sets whether the operation is commutative.
protected void	setFunctionFormat(boolean boo) Sets whether this operation is formatted like a function.
protected void	setSeparator(java.lang.String separator)

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

appendToBuffer, appendToBuffer, argsToString, getName, 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, 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

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

Operation

public Operation()

Operation

public Operation(SQLFragment[] args)

Method Detail

setFunctionFormat

protected void setFunctionFormat(boolean boo)

Sets whether this operation is formatted like a function. i.e.
true - OPERATION(arg1, arg2)
false - arg1 OPERATION arg2 OPERATION arg3

setCommutative

protected void setCommutative(boolean boo)

Sets whether the operation is commutative. If it isn't, then brackets are used to surround child fragments that are of the same operation type.

getArguments

public SQLFragment[] getArguments()

Returns the arguments stored in this function.

setArguments

public void setArguments(SQLFragment[] arguments)

Sets the arguments for this function.

addArgument

public void addArgument(SQLFragment expression)

addArgument

public void addArgument(int index,
                        SQLFragment expression)

addArguments

public void addArguments(SQLFragment[] expressions)

removeArgument

public boolean removeArgument(SQLFragment expression)

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

checkNewSize

protected void checkNewSize(int proposedSize)

Override for operations that have specific size restrictions. Subclasses should throw an IllegalArgumentException if the proposed new size is illegal.

getArgumentCount

public int getArgumentCount()

Returns the number of arguments stored.

getOperatorText

protected abstract java.lang.String getOperatorText()

checkArgument

protected void checkArgument(java.util.List<SQLFragment> existing,
                             SQLFragment add)
                      throws java.lang.IllegalArgumentException

If this returns true the Operation checks that the type of all arguments is the same.

Throws:

java.lang.IllegalArgumentException

setSeparator

protected void setSeparator(java.lang.String separator)

getSeparator

protected java.lang.String getSeparator()

getDistinctText

protected java.lang.String getDistinctText()

Override this for aggregate functions which may take a DISTINCT/UNIQUE/ALL qualifier.

getSQLText

public java.lang.String getSQLText()

Returns the complete SQL representation for this Function fragment.

Specified by:

getSQLText in interface SQLFragment

Returns:

a string representing the SQL text for this object.

equalsImpl

protected boolean equalsImpl(AbstractDBObject other)

Description copied from class: AbstractDBObject

Equals implementation for testing equality with another AbstractDBObject. Override this method (with exact signature) to customise the equality comparison. By default the type, name, schema and all properties in the properties map are compared so in general overrides should not be necessary.

Overrides:

equalsImpl in class AbstractDBObject

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.