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

E13403-04

oracle.javatools.db.sql
Class FKUsage

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.FKUsage
All Implemented Interfaces:
ChildDBObject, DBObject, ProviderUsage, DBObjectUsage, SQLFragment, Copyable, DynamicPropertySet

public class FKUsage
extends AbstractSQLFragment
implements DBObjectUsage

SQLFragment for the usage of a FKConstraint. Creates a JOIN that can be placed within a WhereObject.

Since:
10.1.3

Nested Class Summary
 
Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject
AbstractDBObject.ChildSupport
 
Field Summary
 
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, TYPE, WHERE
 
Fields inherited from interface oracle.javatools.db.DBObject
COMMENT
 
Constructor Summary
FKUsage()
           
FKUsage(DBObjectID fkID, DBObjectID leftID, DBObjectID rightID)
           
 
Method Summary
 DBObject copyTo(DBObject target, DBObject copyParent, IDPolicy idPolicy)
          Internal copy method used by the API to perform copy operations.
protected  void copyToImpl(FKUsage target, DBObject copyParent, IDPolicy idPolicy)
           
 boolean equals(java.lang.Object obj)
           
protected  boolean equalsImpl(FKUsage other)
           
 FromObject getLeftFromObject()
          Deprecated. - use getLeftFromObjectID or resolveLeftFromObject
 DBObjectID getLeftFromObjectID()
           
 DBObjectID getObjectID()
          Gets the id of the FK being used in the SQL of this fragment.
protected  void getReferenceIDsImpl(java.util.Collection<DBObjectID> refs)
          Used by the final getReferenceID() implementation.
 FromObject getRightFromObject()
          Deprecated. - use getRightFromObjectID or resolveRightFromObject
 DBObjectID getRightFromObjectID()
           
 java.lang.String getSQLText()
          Return the SQL for this fragment.
 boolean replaceReferenceIDs(java.util.Map<DBObjectID,DBObjectID> idMap)
          Override in subclasses to replace reference IDs as appropriate.
 FromObject resolveLeftFromObject()
          Resolves the ID for the left From Object of this usage and writes any DBExceptions to the console -- do not use unless you are happy to ignore any DBExceptions.
 FromObject resolveRightFromObject()
          Resolves the ID for the left From Object of this usage and writes any DBExceptions to the console -- do not use unless you are happy to ignore any DBExceptions.
 void setLeftFromObject(FromObject obj)
          Deprecated. - use getLeftFromObjectID or resolveLeftFromObject
 void setLeftFromObjectID(DBObjectID leftID)
           
 void setObjectID(DBObjectID fkid)
          Sets the id of the FK being used in the SQL of this fragment.
 void setProvider(DBObjectProvider pro)
          Sets the provider this usage exists within.
 void setRightFromObject(FromObject from)
          Deprecated. - use setRightFromObjectID
 void setRightFromObjectID(DBObjectID rightID)
           
 
Methods inherited from class oracle.javatools.db.sql.AbstractSQLFragment
appendToBuffer, argsToString, getTextOrNull, getTextOrNull, getType, 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, hashCode, includeOwnedObject, includesType, includesType, removeThisAsParent, 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, setParent
 
Methods inherited from interface oracle.javatools.db.DBObject
copyTo, copyTo, copyTo, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getReferenceIDs, getType, setID, setName
 
Methods inherited from interface oracle.javatools.util.DynamicPropertySet
getProperties, getProperty, getProperty, setProperties, setProperty
 

Constructor Detail

FKUsage

public FKUsage()

FKUsage

public FKUsage(DBObjectID fkID,
               DBObjectID leftID,
               DBObjectID rightID)
Method Detail

getObjectID

public DBObjectID getObjectID()
Gets the id of the FK being used in the SQL of this fragment.

Specified by:
getObjectID in interface DBObjectUsage

setObjectID

public void setObjectID(DBObjectID fkid)
Sets the id of the FK being used in the SQL of this fragment.

Specified by:
setObjectID in interface DBObjectUsage

getLeftFromObject

@Deprecated
public FromObject getLeftFromObject()
Deprecated. - use getLeftFromObjectID or resolveLeftFromObject

Returns:

setLeftFromObject

@Deprecated
public void setLeftFromObject(FromObject obj)
Deprecated. - use getLeftFromObjectID or resolveLeftFromObject


getLeftFromObjectID

public DBObjectID getLeftFromObjectID()

setLeftFromObjectID

public void setLeftFromObjectID(DBObjectID leftID)

getRightFromObjectID

public DBObjectID getRightFromObjectID()

setRightFromObjectID

public void setRightFromObjectID(DBObjectID rightID)

getRightFromObject

@Deprecated
public FromObject getRightFromObject()
Deprecated. - use getRightFromObjectID or resolveRightFromObject

Returns:

setRightFromObject

@Deprecated
public void setRightFromObject(FromObject from)
Deprecated. - use setRightFromObjectID


resolveLeftFromObject

public FromObject resolveLeftFromObject()
Resolves the ID for the left From Object of this usage and writes any DBExceptions to the console -- do not use unless you are happy to ignore any DBExceptions.

Returns:

resolveRightFromObject

public FromObject resolveRightFromObject()
Resolves the ID for the left From Object of this usage and writes any DBExceptions to the console -- do not use unless you are happy to ignore any DBExceptions.

Returns:

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.

equals

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

equalsImpl

protected boolean equalsImpl(FKUsage other)

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(FKUsage target,
                          DBObject copyParent,
                          IDPolicy idPolicy)

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

getReferenceIDsImpl

protected void getReferenceIDsImpl(java.util.Collection<DBObjectID> refs)
Description copied from class: AbstractDBObject
Used by the final getReferenceID() implementation. The list should not contain null values, or be null. Subclasses should start with super.getReferenceIDsImpl() and then add to the passed list as appopriate.

Overrides:
getReferenceIDsImpl in class AbstractDBObject
Parameters:
refs - the collection of ids this object references

replaceReferenceIDs

public boolean replaceReferenceIDs(java.util.Map<DBObjectID,DBObjectID> idMap)
Description copied from class: AbstractDBObject
Override in subclasses to replace reference IDs as appropriate. Always call super in the overridden implementation to make sure the default implementation (which checks the property map) is called.

Specified by:
replaceReferenceIDs in interface DBObject
Overrides:
replaceReferenceIDs in class AbstractDBObject
Parameters:
idMap - key = old DBObjectID, value = new DBObjectID
Returns:
true if any ids were replaced.

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.