Top Description Fields Constructors Methods
org.eclipse.persistence.internal.jpa.metadata.queries

public Class NamedQueryMetadata

extends ORMetadata
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.metadata.queries.NamedNativeQueryMetadata
Imports
java.util.ArrayList, .Arrays, .HashMap, .List, .Map, org.eclipse.persistence.descriptors.ClassDescriptor, org.eclipse.persistence.exceptions.ValidationException, org.eclipse.persistence.internal.jpa.JPAQuery, .QueryHintsHandler, org.eclipse.persistence.internal.jpa.jpql.JPQLQueryHelper, org.eclipse.persistence.internal.jpa.metadata.ORMetadata, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotation, org.eclipse.persistence.internal.sessions.AbstractSession
INTERNAL: Object to hold onto a named query metadata. Key notes: - any metadata mapped from XML to this class must be compared in the equals method. - all metadata mapped from XML should be initialized in the initXMLObject method. - when loading from annotations, the constructor accepts the metadata accessor this metadata was loaded from. Used it to look up any 'companion' annotation needed for processing. - methods should be preserved in alphabetical order.
Author
Guy Pelletier
Since
TopLink EJB 3.0 Reference Implementation

Field Summary

Modifier and TypeField and Description
private List<QueryHintMetadata>
m_hints

private String
m_lockMode

private String
m_name

private String
m_query

Inherited from org.eclipse.persistence.internal.jpa.metadata.ORMetadata:
m_project

Constructor Summary

AccessConstructor and Description
public
NamedQueryMetadata()

INTERNAL: Used for XML loading.

public
NamedQueryMetadata(MetadataAnnotation namedQuery, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

protected
NamedQueryMetadata(String xmlElement)

INTERNAL: Used for XML loading.

Method Summary

Modifier and TypeMethod and Description
protected void
addJPAQuery(JPAQuery query, AbstractSession session)

INTERNAL: Add the query the session.

public boolean
equals(Object
the reference object with which to compare.
objectToCompare)

Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals.

INTERNAL:
public List<QueryHintMetadata>
getHints()

INTERNAL: Used for OX mapping.

public String
getIdentifier()

Overrides org.eclipse.persistence.internal.jpa.metadata.ORMetadata.getIdentifier.

INTERNAL: To satisfy the abstract getIdentifier() method from ORMetadata.
public String
getLockMode()

INTERNAL: Used for OX mapping.

public String
getName()

INTERNAL: Used for OX mapping.

public String
getQuery()

INTERNAL: Used for OX mapping.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public void
process(AbstractSession session)

INTERNAL:

protected Map<String, Object>
processQueryHints(AbstractSession session)

INTERNAL:

public void
setHints(List<QueryHintMetadata> hints)

INTERNAL: Used for OX mapping.

public void
setLockMode(String lockMode)

INTERNAL: Used for OX mapping.

public void
setName(String name)

INTERNAL: Used for OX mapping.

public void
setQuery(String query)

INTERNAL: Used for OX mapping.

Inherited from org.eclipse.persistence.internal.jpa.metadata.ORMetadata:
getAccessibleObjectgetAccessibleObjectNamegetAnnotationgetBoxedTypegetDatabaseTypeEnumgetEntityMappingsgetFullyQualifiedClassNamegetJavaClassgetJavaClassNamegetLoadergetLocationgetLoggergetMetadataClassgetMetadataClassgetMetadataClassgetMetadataFactorygetNamegetPrimitiveClassForNamegetProjectgetTextgetXMLElementhasIdentifierhasTextinitXMLClassNameinitXMLObjectinitXMLObjectinitXMLObjectsinitXMLTextObjectloadedFromAnnotationloadedFromEclipseLinkXMLloadedFromXMLmergemergeORObjectListsmergeORObjectsmergeSimpleObjectsreloadEntityreloadMappedSuperclasssetAccessibleObjectsetEntityMappingssetFieldNamesetFieldNamesetProjectshouldOverridevaluesMatchvaluesMatch

Field Detail

m_hintsback to summary
private List<QueryHintMetadata> m_hints
m_lockModeback to summary
private String m_lockMode
m_nameback to summary
private String m_name
m_queryback to summary
private String m_query

Constructor Detail

NamedQueryMetadataback to summary
public NamedQueryMetadata()

INTERNAL: Used for XML loading.

NamedQueryMetadataback to summary
public NamedQueryMetadata(MetadataAnnotation namedQuery, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

NamedQueryMetadataback to summary
protected NamedQueryMetadata(String xmlElement)

INTERNAL: Used for XML loading.

Method Detail

addJPAQueryback to summary
protected void addJPAQuery(JPAQuery query, AbstractSession session)

INTERNAL: Add the query the session. Table per tenant queries should not be added to the regular query list as these queries may need to be initialized per EM.

equalsback to summary
public boolean equals(Object objectToCompare)

Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals.

INTERNAL:

Parameters
objectToCompare:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getHintsback to summary
public List<QueryHintMetadata> getHints()

INTERNAL: Used for OX mapping.

getIdentifierback to summary
public String getIdentifier()

Overrides org.eclipse.persistence.internal.jpa.metadata.ORMetadata.getIdentifier.

INTERNAL: To satisfy the abstract getIdentifier() method from ORMetadata.

Annotations
@Override
getLockModeback to summary
public String getLockMode()

INTERNAL: Used for OX mapping.

getNameback to summary
public String getName()

INTERNAL: Used for OX mapping.

getQueryback to summary
public String getQuery()

INTERNAL: Used for OX mapping.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
processback to summary
public void process(AbstractSession session)

INTERNAL:

processQueryHintsback to summary
protected Map<String, Object> processQueryHints(AbstractSession session)

INTERNAL:

setHintsback to summary
public void setHints(List<QueryHintMetadata> hints)

INTERNAL: Used for OX mapping.

setLockModeback to summary
public void setLockMode(String lockMode)

INTERNAL: Used for OX mapping.

setNameback to summary
public void setName(String name)

INTERNAL: Used for OX mapping.

setQueryback to summary
public void setQuery(String query)

INTERNAL: Used for OX mapping.