FileDocCategorySizeDatePackage
DirectQueryKey.javaAPI DocGlassfish v2 API3832Tue May 22 16:54:50 BST 2007oracle.toplink.essentials.querykeys

DirectQueryKey

public class DirectQueryKey extends QueryKey

Purpose: Define an alias to a database field.

Responsibilities:

  • Define the field that is being aliased.

Fields Summary
DatabaseField
field
Constructors Summary
Methods Summary
public oracle.toplink.essentials.internal.helper.DatabaseFieldgetField()
INTERNAL: Return the field for the query key.

        return field;
public java.lang.StringgetFieldName()
PUBLIC: Return the field name for the query key.

        return getField().getName();
public java.lang.StringgetQualifiedFieldName()
PUBLIC: Return the qualified field name for the query key.

        return getField().getQualifiedName();
public voidinitialize(oracle.toplink.essentials.descriptors.ClassDescriptor descriptor)
INTERNAL: Initialize any information in the receiver that requires its descriptor. Set the receiver's descriptor back reference.

param
descriptor is the owner descriptor of the receiver.

        super.initialize(descriptor);
        if (!getField().hasTableName()) {
            getField().setTable(descriptor.getDefaultTable());
        }
public booleanisDirectQueryKey()
INTERNAL: override the isDirectQueryKey() method in the superclass to return true.

return
boolean

        return true;
public voidsetField(oracle.toplink.essentials.internal.helper.DatabaseField field)
INTERNAL: Set the field for the query key.

        this.field = field;
public voidsetFieldName(java.lang.String fieldName)
PUBLIC: Set the field name for the query key.

        setField(new DatabaseField(fieldName));