Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1)

E13403-04

oracle.javatools.db.sql
Class WhereObject

java.lang.Object
  extended by oracle.javatools.db.AbstractDBObject
      extended by oracle.javatools.db.AbstractChildDBObject
          extended by oracle.javatools.db.sql.AbstractSQLFragment
              extended by oracle.javatools.db.sql.Operation
                  extended by oracle.javatools.db.sql.WhereObject
All Implemented Interfaces:
ChildDBObject, DBObject, SQLFragment, Copyable, DynamicPropertySet
Direct Known Subclasses:
OnJoinCondition

public class WhereObject
extends Operation

Object that represents a clause in the WHERE statement of a SQL query. The WHERE statement itself is one of these objects, and can contain child WhereObjects.

Since:
10.1.3

Nested Class Summary
 
Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject
AbstractDBObject.ChildSupport
 
Field Summary
static int AND
          AND
static int OR
          OR
static java.lang.String TYPE
           
 
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, WHERE
 
Fields inherited from interface oracle.javatools.db.DBObject
COMMENT
 
Constructor Summary
WhereObject()
          Creates an empty WhereObject.
WhereObject(SQLFragment exp)
          Where object with only one clause.
WhereObject(SQLFragment[] expressions, int logic)
          Creates a WhereObject with the given expressions.
 
Method Summary
 DBObject copyTo(DBObject target, DBObject copyParent, IDPolicy idPolicy)
          Internal copy method used by the API to perform copy operations.
protected  void copyToImpl(WhereObject target, DBObject copyParent, IDPolicy idPolicy)
           
 boolean equals(java.lang.Object obj)
           
protected  boolean equalsImpl(WhereObject other)
           
 int getOperator()
          Gets whether this is an AND or OR condition.
 java.lang.String getOperatorText()
           
static java.lang.String getOperatorText(int logic)
           
 java.lang.String getType()
          Returns the type of this object.
static boolean isWhereOperator(int logic)
           
 void setOperator(int logic)
          Sets whether this is an AND or OR condition.
 
Methods inherited from class oracle.javatools.db.sql.Operation
addArgument, addArgument, addArguments, checkArgument, checkNewSize, copyToImpl, equalsImpl, getArgumentCount, getArguments, getDistinctText, getSeparator, getSQLText, removeArgument, setArguments, setCommutative, setFunctionFormat, setSeparator
 
Methods inherited from class oracle.javatools.db.sql.AbstractSQLFragment
appendToBuffer, argsToString, getTextOrNull, getTextOrNull, 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, getReferenceIDsImpl, hashCode, includeOwnedObject, includesType, includesType, 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.ChildDBObject
getParent
 
Methods inherited from interface oracle.javatools.db.DBObject
copyTo, copyTo, copyTo, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getReferenceIDs, replaceReferenceIDs, setID, setName
 
Methods inherited from interface oracle.javatools.util.DynamicPropertySet
getProperties, getProperty, getProperty, setProperties, setProperty
 

Field Detail

TYPE

public static final java.lang.String TYPE
See Also:
Constant Field Values

AND

public static final int AND
AND

See Also:
Constant Field Values

OR

public static final int OR
OR

See Also:
Constant Field Values
Constructor Detail

WhereObject

public WhereObject()
Creates an empty WhereObject.


WhereObject

public WhereObject(SQLFragment exp)
Where object with only one clause. Used only for a WHERE expression without an AND or OR.


WhereObject

public WhereObject(SQLFragment[] expressions,
                   int logic)
Creates a WhereObject with the given expressions. The boolean parameter sets whether to use an AND or OR.

Method Detail

getType

public java.lang.String getType()
Description copied from interface: DBObject
Returns the type of this object. Valid types include things like tables, views, synonyms, and columns.

Specified by:
getType in interface DBObject
Overrides:
getType in class AbstractSQLFragment
Returns:
a string describing the type of object.

setOperator

public void setOperator(int logic)
Sets whether this is an AND or OR condition.


getOperator

public int getOperator()
Gets whether this is an AND or OR condition.


getOperatorText

public java.lang.String getOperatorText()
Specified by:
getOperatorText in class Operation

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)

copyToImpl

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

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

equalsImpl

protected boolean equalsImpl(WhereObject other)

isWhereOperator

public static boolean isWhereOperator(int logic)

getOperatorText

public static java.lang.String getOperatorText(int logic)

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1)

E13403-04

Copyright © 1997, 2010, Oracle. All rights reserved.