oracle.toplink.querykeys
Class ForeignReferenceQueryKey

java.lang.Object
  oracle.toplink.querykeys.QueryKey
      oracle.toplink.querykeys.ForeignReferenceQueryKey

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

DirectCollectionQueryKey, ManyToManyQueryKey, OneToManyQueryKey, OneToOneQueryKey

public class ForeignReferenceQueryKey
extends QueryKey

Purpose: Define an alias to a foreign object.

Responsibilities:

• Define the reference class of the foreign object.

See Also:

Serialized Form

Constructor Summary

ForeignReferenceQueryKey()

Method Summary

Expression	getJoinCriteria() Return the join expression for the relationship defined by the query key.
java.lang.Class	getReferenceClass() Return the reference class of the relationship.
java.lang.String	getReferenceClassName() Return the reference class name of the relationship.
void	setJoinCriteria(Expression joinCriteria) Set the join expression for the relationship defined by the query key.
void	setReferenceClass(java.lang.Class referenceClass) Set the reference class of the relationship.
void	setReferenceClassName(java.lang.String referenceClassName) Set the reference class name for this relationship This is used when projects are built without using classes

Methods inherited from class oracle.toplink.querykeys.QueryKey

getName, isCollectionQueryKey, isDirectCollectionQueryKey, isDirectQueryKey, isManyToManyQueryKey, isOneToManyQueryKey, isOneToOneQueryKey, setName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ForeignReferenceQueryKey

public ForeignReferenceQueryKey()

Method Detail

getJoinCriteria

public Expression getJoinCriteria()

Return the join expression for the relationship defined by the query key.

getReferenceClass

public java.lang.Class getReferenceClass()

Return the reference class of the relationship.

getReferenceClassName

public java.lang.String getReferenceClassName()

Return the reference class name of the relationship.

setJoinCriteria

public void setJoinCriteria(Expression joinCriteria)

Set the join expression for the relationship defined by the query key.

Example:

     builder.getField("ADDRESS.ADDRESS_ID").equal(builder.getParameter("EMPLOYEE.ADDR_ID");
 

setReferenceClass

public void setReferenceClass(java.lang.Class referenceClass)

Set the reference class of the relationship. This is not required for direct collection query keys.

setReferenceClassName

public void setReferenceClassName(java.lang.String referenceClassName)

Set the reference class name for this relationship This is used when projects are built without using classes

Parameters:

referenceClassName -