Package org.eclipse.persistence.mappings.querykeys

Class DirectQueryKey

java.lang.Object

org.eclipse.persistence.mappings.querykeys.QueryKey

org.eclipse.persistence.mappings.querykeys.DirectQueryKey

All Implemented Interfaces:

Serializable, Cloneable

public class DirectQueryKey
extends QueryKey

Purpose: Define an alias to a database field.

Responsibilities:

• Define the field that is being aliased.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.eclipse.persistence.mappings.querykeys.QueryKey

descriptor, name

Constructor Summary

Constructors

Constructor	Description
DirectQueryKey()

Method Summary

Modifier and Type	Method	Description
org.eclipse.persistence.internal.helper.DatabaseField	getField()	INTERNAL: Return the field for the query key.
String	getFieldName()	PUBLIC: Return the field name for the query key.
String	getQualifiedFieldName()	PUBLIC: Return the qualified field name for the query key.
void	initialize(ClassDescriptor descriptor)	INTERNAL: Initialize any information in the receiver that requires its descriptor.
boolean	isDirectQueryKey()	INTERNAL: override the isDirectQueryKey() method in the superclass to return true.
void	setField(org.eclipse.persistence.internal.helper.DatabaseField field)	INTERNAL: Set the field for the query key.
void	setFieldName(String fieldName)	PUBLIC: Set the field name for the query key.

Methods inherited from class org.eclipse.persistence.mappings.querykeys.QueryKey

clone, convertClassNamesToClasses, getDescriptor, getName, isAbstractQueryKey, isCollectionQueryKey, isDirectCollectionQueryKey, isForeignReferenceQueryKey, isManyToManyQueryKey, isOneToManyQueryKey, isOneToOneQueryKey, isQueryKey, setDescriptor, setName, toString

Methods inherited from class java.lang.Object

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

Constructor Details

DirectQueryKey

public DirectQueryKey()

Method Details

getField

public org.eclipse.persistence.internal.helper.DatabaseField getField()

INTERNAL: Return the field for the query key.

getFieldName

public String getFieldName()

PUBLIC: Return the field name for the query key.

getQualifiedFieldName

public String getQualifiedFieldName()

PUBLIC: Return the qualified field name for the query key.

initialize

public void initialize(ClassDescriptor descriptor)

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

Overrides:

initialize in class QueryKey

Parameters:

descriptor - is the owner descriptor of the receiver.

isDirectQueryKey

public boolean isDirectQueryKey()

INTERNAL: override the isDirectQueryKey() method in the superclass to return true.

Overrides:

isDirectQueryKey in class QueryKey

Returns:

boolean

setField

public void setField(org.eclipse.persistence.internal.helper.DatabaseField field)

INTERNAL: Set the field for the query key.

setFieldName

public void setFieldName(String fieldName)

PUBLIC: Set the field name for the query key.