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

QueryKey

public class QueryKey extends Object implements Serializable, Cloneable

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

Responsibilities:

  • Define the name of the alias.
  • Define the descriptor of the alias.

Fields Summary
protected String
name
protected ClassDescriptor
descriptor
Constructors Summary
Methods Summary
public java.lang.Objectclone()
INTERNAL: Clones itself.

        Object object = null;

        try {
            object = super.clone();
        } catch (Exception exception) {
            throw new InternalError(exception.toString());
        }

        return object;
public voidconvertClassNamesToClasses(java.lang.ClassLoader classLoader)
INTERNAL: Convert all the class-name-based settings in this QueryKey to actual class-based settings Will be overridded by subclasses

param
classLoader

public oracle.toplink.essentials.descriptors.ClassDescriptorgetDescriptor()
INTERNAL:
Return the descriptor.
        return descriptor;
    
public java.lang.StringgetName()
PUBLIC:
Return the name for the query key.
This is the name that will be used in the expression.
        return name;
    
public voidinitialize(oracle.toplink.essentials.descriptors.ClassDescriptor aDescriptor)
INTERNAL:
Initialize any information in the receiver that requires its descriptor.
Set the receiver's descriptor back reference.
param
aDescriptor is the owner descriptor of the receiver.
        setDescriptor(aDescriptor);
    
public booleanisAbstractQueryKey()
INTERNAL:
return whether this query key is abstract
return
boolean
        return (this.getClass().equals(oracle.toplink.essentials.internal.helper.ClassConstants.QueryKey_Class));
    
public booleanisCollectionQueryKey()
PUBLIC::
Related query key should implement this method to return true.
        return false;
    
public booleanisDirectCollectionQueryKey()
PUBLIC::
Related query key should implement this method to return true.
        return false;
    
public booleanisDirectQueryKey()
PUBLIC::
Related query key should implement this method to return true.
        return false;
    
public booleanisForeignReferenceQueryKey()
PUBLIC::
Related query key should implement this method to return true.
        return false;
    
public booleanisManyToManyQueryKey()
PUBLIC::
Related query key should implement this method to return true.
        return false;
    
public booleanisOneToManyQueryKey()
PUBLIC::
Related query key should implement this method to return true.
        return false;
    
public booleanisOneToOneQueryKey()
PUBLIC::
Related query key should implement this method to return true.
        return false;
    
public booleanisQueryKey()
INTERNAL:
This is a QueryKey. return true.
return
boolean
        return true;
    
public voidsetDescriptor(oracle.toplink.essentials.descriptors.ClassDescriptor descriptor)
INTERNAL:
Set the descriptor.
        this.descriptor = descriptor;
    
public voidsetName(java.lang.String name)
PUBLIC:
Set the name for the query key.
This is the name that will be used in the expression.
        this.name = name;
    
public java.lang.StringtoString()
INTERNAL:
return a string representation of this instance of QueryKey
        return oracle.toplink.essentials.internal.helper.Helper.getShortClassName(this) + "(" + getName() + ")";