Top Description Fields Constructors Methods
org.eclipse.persistence.mappings.querykeys

public Class QueryKey

extends Object
implements Cloneable, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, java.lang.Cloneable
Known Direct Subclasses
org.eclipse.persistence.mappings.querykeys.DirectQueryKey, org.eclipse.persistence.mappings.querykeys.ForeignReferenceQueryKey
Imports
java.io.*, org.eclipse.persistence.descriptors.ClassDescriptor

Purpose: Define a Java appropriate alias to a database field or function.

Responsibilities:

Field Summary

Modifier and TypeField and Description
protected ClassDescriptor
descriptor

protected String
name

Constructor Summary

AccessConstructor and Description
public
QueryKey()

Default constructor.

Method Summary

Modifier and TypeMethod and Description
public Object
clone()

Overrides java.lang.Object.clone.

INTERNAL: Clones itself.
public void
convertClassNamesToClasses(ClassLoader classLoader)

INTERNAL: Convert all the class-name-based settings in this QueryKey to actual class-based settings Will be overridded by subclasses

public ClassDescriptor
getDescriptor()

INTERNAL: Return the descriptor.

public String
getName()

PUBLIC: Return the name for the query key.

public void
initialize(ClassDescriptor
is the owner descriptor of the receiver.
aDescriptor)

INTERNAL: Initialize any information in the receiver that requires its descriptor.

public boolean

Returns:

boolean
isAbstractQueryKey()

INTERNAL: return whether this query key is abstract

public boolean
isCollectionQueryKey()

PUBLIC:: Related query key should implement this method to return true.

public boolean
isDirectCollectionQueryKey()

PUBLIC:: Related query key should implement this method to return true.

public boolean
isDirectQueryKey()

PUBLIC:: Related query key should implement this method to return true.

public boolean
isForeignReferenceQueryKey()

PUBLIC:: Related query key should implement this method to return true.

public boolean
isManyToManyQueryKey()

PUBLIC:: Related query key should implement this method to return true.

public boolean
isOneToManyQueryKey()

PUBLIC:: Related query key should implement this method to return true.

public boolean
isOneToOneQueryKey()

PUBLIC:: Related query key should implement this method to return true.

public boolean

Returns:

boolean
isQueryKey()

INTERNAL: This is a QueryKey.

public void
setDescriptor(ClassDescriptor descriptor)

INTERNAL: Set the descriptor.

public void
setName(String name)

PUBLIC: Set the name for the query key.

public String
toString()

Overrides java.lang.Object.toString.

INTERNAL: return a string representation of this instance of QueryKey
Inherited from java.lang.Object:
equalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

descriptorback to summary
protected ClassDescriptor descriptor
nameback to summary
protected String name

Constructor Detail

QueryKeyback to summary
public QueryKey()

Default constructor.

Method Detail

cloneback to summary
public Object clone()

Overrides java.lang.Object.clone.

INTERNAL: Clones itself.

Returns:Object

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations
@Override
convertClassNamesToClassesback to summary
public void convertClassNamesToClasses(ClassLoader classLoader)

INTERNAL: Convert all the class-name-based settings in this QueryKey to actual class-based settings Will be overridded by subclasses

getDescriptorback to summary
public ClassDescriptor getDescriptor()

INTERNAL: Return the descriptor.

getNameback to summary
public String getName()

PUBLIC: Return the name for the query key. This is the name that will be used in the expression.

initializeback to summary
public void initialize(ClassDescriptor aDescriptor)

INTERNAL: Initialize any information in the receiver that requires its descriptor. Set the receiver's descriptor back reference.

Parameters
aDescriptor:ClassDescriptor

is the owner descriptor of the receiver.

isAbstractQueryKeyback to summary
public boolean isAbstractQueryKey()

INTERNAL: return whether this query key is abstract

Returns:boolean

boolean

isCollectionQueryKeyback to summary
public boolean isCollectionQueryKey()

PUBLIC:: Related query key should implement this method to return true.

isDirectCollectionQueryKeyback to summary
public boolean isDirectCollectionQueryKey()

PUBLIC:: Related query key should implement this method to return true.

isDirectQueryKeyback to summary
public boolean isDirectQueryKey()

PUBLIC:: Related query key should implement this method to return true.

isForeignReferenceQueryKeyback to summary
public boolean isForeignReferenceQueryKey()

PUBLIC:: Related query key should implement this method to return true.

isManyToManyQueryKeyback to summary
public boolean isManyToManyQueryKey()

PUBLIC:: Related query key should implement this method to return true.

isOneToManyQueryKeyback to summary
public boolean isOneToManyQueryKey()

PUBLIC:: Related query key should implement this method to return true.

isOneToOneQueryKeyback to summary
public boolean isOneToOneQueryKey()

PUBLIC:: Related query key should implement this method to return true.

isQueryKeyback to summary
public boolean isQueryKey()

INTERNAL: This is a QueryKey. return true.

Returns:boolean

boolean

setDescriptorback to summary
public void setDescriptor(ClassDescriptor descriptor)

INTERNAL: Set the descriptor.

setNameback to summary
public void setName(String name)

PUBLIC: Set the name for the query key. This is the name that will be used in the expression.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

INTERNAL: return a string representation of this instance of QueryKey

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations
@Override