Module org.eclipse.persistence.jpa

Package org.eclipse.persistence.internal.jpa.metadata.queries

Class NamedQueryMetadata

java.lang.Object

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

org.eclipse.persistence.internal.jpa.metadata.queries.NamedQueryMetadata

Direct Known Subclasses:

NamedNativeQueryMetadata

public class NamedQueryMetadata
extends ORMetadata

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.

Since:

TopLink EJB 3.0 Reference Implementation

Field Summary

Fields inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata

m_project

Constructor Summary

Constructors

Modifier	Constructor	Description
	NamedQueryMetadata()	INTERNAL: Used for XML loading.
protected	NamedQueryMetadata(String xmlElement)	INTERNAL: Used for XML loading.
	NamedQueryMetadata(MetadataAnnotation namedQuery, MetadataAccessor accessor)	INTERNAL: Used for annotation loading.

Method Summary

Modifier and Type	Method	Description
protected void	addJPAQuery(JPAQuery query, AbstractSession session)	INTERNAL: Add the query the session.
boolean	equals(Object objectToCompare)	INTERNAL:
List<QueryHintMetadata>	getHints()	INTERNAL: Used for OX mapping.
String	getIdentifier()	INTERNAL: To satisfy the abstract getIdentifier() method from ORMetadata.
String	getLockMode()	INTERNAL: Used for OX mapping.
String	getName()	INTERNAL: Used for OX mapping.
String	getQuery()	INTERNAL: Used for OX mapping.
MetadataClass	getResultClass()	INTERNAL:
String	getResultClassName()	INTERNAL: Used for OX mapping.
int	hashCode()
void	initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)	INTERNAL:
void	process(AbstractSession session)	INTERNAL:
protected Map<String,Object>	processQueryHints(AbstractSession session)	INTERNAL:
void	setHints(List<QueryHintMetadata> hints)	INTERNAL: Used for OX mapping.
void	setLockMode(String lockMode)	INTERNAL: Used for OX mapping.
void	setName(String name)	INTERNAL: Used for OX mapping.
void	setQuery(String query)	INTERNAL: Used for OX mapping.
void	setResultClass(MetadataClass resultClass)	INTERNAL:
void	setResultClassName(String resultClassName)	INTERNAL: Used for OX mapping.

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata

getAccessibleObject, getAccessibleObjectName, getAnnotation, getBoxedType, getDatabaseTypeEnum, getEntityMappings, getFullyQualifiedClassName, getJavaClass, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getName, getPrimitiveClassForName, getProject, getText, getXMLElement, hasIdentifier, hasText, initXMLClassName, initXMLObject, initXMLObjects, initXMLTextObject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, merge, mergeORObjectLists, mergeORObjects, mergeSimpleObjects, reloadEntity, reloadMappedSuperclass, setAccessibleObject, setEntityMappings, setFieldName, setFieldName, setProject, shouldOverride, valuesMatch, valuesMatch

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NamedQueryMetadata

public NamedQueryMetadata()

INTERNAL: Used for XML loading.

NamedQueryMetadata

public NamedQueryMetadata(MetadataAnnotation namedQuery,
 MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

NamedQueryMetadata

protected NamedQueryMetadata(String xmlElement)

INTERNAL: Used for XML loading.

Method Details

addJPAQuery

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.

equals

public boolean equals(Object objectToCompare)

INTERNAL:

Specified by:

equals in class ORMetadata

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getHints

public List<QueryHintMetadata> getHints()

INTERNAL: Used for OX mapping.

getIdentifier

public String getIdentifier()

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

Overrides:

getIdentifier in class ORMetadata

See Also:

• ORMetadata.shouldOverride(ORMetadata)
• ORMetadata.mergeORObjects(ORMetadata, ORMetadata)
• ORMetadata.mergeORObjectLists(List, List)

getLockMode

public String getLockMode()

INTERNAL: Used for OX mapping.

getName

public String getName()

INTERNAL: Used for OX mapping.

getQuery

public String getQuery()

INTERNAL: Used for OX mapping.

getResultClass

public MetadataClass getResultClass()

INTERNAL:

getResultClassName

public String getResultClassName()

INTERNAL: Used for OX mapping.

initXMLObject

public void initXMLObject(MetadataAccessibleObject accessibleObject,
 XMLEntityMappings entityMappings)

INTERNAL:

Overrides:

initXMLObject in class ORMetadata

process

public void process(AbstractSession session)

INTERNAL:

processQueryHints

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

INTERNAL:

setHints

public void setHints(List<QueryHintMetadata> hints)

INTERNAL: Used for OX mapping.

setLockMode

public void setLockMode(String lockMode)

INTERNAL: Used for OX mapping.

setName

public void setName(String name)

INTERNAL: Used for OX mapping.

setQuery

public void setQuery(String query)

INTERNAL: Used for OX mapping.

setResultClass

public void setResultClass(MetadataClass resultClass)

INTERNAL:

setResultClassName

public void setResultClassName(String resultClassName)

INTERNAL: Used for OX mapping.