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

public Class DirectQueryKey

extends QueryKey
Class Inheritance
Imports
org.eclipse.persistence.descriptors.ClassDescriptor, org.eclipse.persistence.internal.helper.DatabaseField

Purpose: Define an alias to a database field.

Responsibilities:

Field Summary

Modifier and TypeField and Description
pack-priv DatabaseField
field

Inherited from org.eclipse.persistence.mappings.querykeys.QueryKey:
descriptorname

Constructor Summary

AccessConstructor and Description
public
DirectQueryKey()

Method Summary

Modifier and TypeMethod and Description
public DatabaseField
getField()

INTERNAL: Return the field for the query key.

public String
getFieldName()

PUBLIC: Return the field name for the query key.

public String
getQualifiedFieldName()

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

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

Overrides org.eclipse.persistence.mappings.querykeys.QueryKey.initialize.

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

Returns:

boolean
isDirectQueryKey()

Overrides org.eclipse.persistence.mappings.querykeys.QueryKey.isDirectQueryKey.

INTERNAL: override the isDirectQueryKey() method in the superclass to return true.
public void
setField(DatabaseField field)

INTERNAL: Set the field for the query key.

public void
setFieldName(String fieldName)

PUBLIC: Set the field name for the query key.

Inherited from org.eclipse.persistence.mappings.querykeys.QueryKey:
cloneconvertClassNamesToClassesgetDescriptorgetNameisAbstractQueryKeyisCollectionQueryKeyisDirectCollectionQueryKeyisForeignReferenceQueryKeyisManyToManyQueryKeyisOneToManyQueryKeyisOneToOneQueryKeyisQueryKeysetDescriptorsetNametoString

Field Detail

fieldback to summary
pack-priv DatabaseField field

Constructor Detail

DirectQueryKeyback to summary
public DirectQueryKey()

Method Detail

getFieldback to summary
public DatabaseField getField()

INTERNAL: Return the field for the query key.

getFieldNameback to summary
public String getFieldName()

PUBLIC: Return the field name for the query key.

getQualifiedFieldNameback to summary
public String getQualifiedFieldName()

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

initializeback to summary
public void initialize(ClassDescriptor descriptor)

Overrides org.eclipse.persistence.mappings.querykeys.QueryKey.initialize.

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

Parameters
descriptor:ClassDescriptor

is the owner descriptor of the receiver.

Annotations
@Override
isDirectQueryKeyback to summary
public boolean isDirectQueryKey()

Overrides org.eclipse.persistence.mappings.querykeys.QueryKey.isDirectQueryKey.

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

Returns:boolean

boolean

Annotations
@Override
setFieldback to summary
public void setField(DatabaseField field)

INTERNAL: Set the field for the query key.

setFieldNameback to summary
public void setFieldName(String fieldName)

PUBLIC: Set the field name for the query key.