Skip navigation links
oracle.javatools.db.sql
Class FKUsage
java.lang.Object
oracle.javatools.db.AbstractDBObject
oracle.javatools.db.AbstractChildDBObject
oracle.javatools.db.sql.AbstractSQLFragment
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
Fields inherited from interface oracle.javatools.db.sql.SQLFragment |
CONNECTBY, FROM, GROUPBY, HAVING, MODEL, NOCYCLE, ORDERBY, ORDERSIBLINGSBY, PRIOR, SELECT, STARTWITH, TYPE, WHERE |
Methods inherited from class oracle.javatools.db.sql.AbstractSQLFragment |
appendToBuffer, argsToString, getStartOffset, getTextOrNull, getTextOrNull, getType, setParent, setStartOffset, surroundWithBrackets, surroundWithBrackets, toString |
Methods inherited from class oracle.javatools.db.AbstractDBObject |
changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getOwnedObjectsImpl, getProperties, getProperty, getReferenceIDs, getReferenceIDsImpl, hashCode, includeOwnedObject, includesType, includesType, removeThisAsParent, replaceReferenceIDs, setID, setName, setProperties |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface oracle.javatools.db.DBObject |
copyTo, copyTo, copyTo, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getReferenceIDs, getType, replaceReferenceIDs, setID, setName |
FKUsage
public FKUsage()
FKUsage
public FKUsage(DBObjectID fkID,
DBObjectID leftID,
DBObjectID rightID)
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 obj)
- 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.
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
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 AbstractChildDBObject
-
- 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.
Skip navigation links
Copyright © 1997, 2012, Oracle. All rights reserved.