Package org.eclipse.persistence.mappings.querykeys

Class QueryKey

java.lang.Object
org.eclipse.persistence.mappings.querykeys.QueryKey
All Implemented Interfaces:
Serializable, Cloneable
Direct Known Subclasses:
DirectQueryKey, ForeignReferenceQueryKey
public class QueryKey extends Object implements Cloneable, Serializable

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.
See Also:

  • Field Details

  • Constructor Details

    • QueryKey

      public QueryKey()

  • Method Details

    • clone

      public Object clone()
      INTERNAL: Clones itself.
      Overrides:
      clone in class Object

    • convertClassNamesToClasses

      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
      Parameters:
      classLoader -

    • getDescriptor

      public ClassDescriptor getDescriptor()
      INTERNAL: Return the descriptor.

    • getName

      public String getName()
      PUBLIC: Return the name for the query key. This is the name that will be used in the expression.

    • initialize

      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 - is the owner descriptor of the receiver.

    • isAbstractQueryKey

      public boolean isAbstractQueryKey()
      INTERNAL: return whether this query key is abstract
      Returns:
      boolean

    • isCollectionQueryKey

      public boolean isCollectionQueryKey()
      PUBLIC:: Related query key should implement this method to return true.

    • isDirectCollectionQueryKey

      public boolean isDirectCollectionQueryKey()
      PUBLIC:: Related query key should implement this method to return true.

    • isDirectQueryKey

      public boolean isDirectQueryKey()
      PUBLIC:: Related query key should implement this method to return true.

    • isForeignReferenceQueryKey

      public boolean isForeignReferenceQueryKey()
      PUBLIC:: Related query key should implement this method to return true.

    • isManyToManyQueryKey

      public boolean isManyToManyQueryKey()
      PUBLIC:: Related query key should implement this method to return true.

    • isOneToManyQueryKey

      public boolean isOneToManyQueryKey()
      PUBLIC:: Related query key should implement this method to return true.

    • isOneToOneQueryKey

      public boolean isOneToOneQueryKey()
      PUBLIC:: Related query key should implement this method to return true.

    • isQueryKey

      public boolean isQueryKey()
      INTERNAL: This is a QueryKey. return true.
      Returns:
      boolean

    • setDescriptor

      public void setDescriptor(ClassDescriptor descriptor)
      INTERNAL: Set the descriptor.

    • setName

      public void setName(String name)
      PUBLIC: Set the name for the query key. This is the name that will be used in the expression.

    • toString

      public String toString()
      INTERNAL: return a string representation of this instance of QueryKey
      Overrides:
      toString in class Object