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

public Class NamedNativeQueryMetadata

extends NamedQueryMetadata
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.metadata.queries.NamedPLSQLStoredProcedureQueryMetadata, org.eclipse.persistence.internal.jpa.metadata.queries.NamedStoredProcedureQueryMetadata
Imports
org.eclipse.persistence.exceptions.ValidationException, org.eclipse.persistence.internal.jpa.JPAQuery, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject, .MetadataAnnotation, .MetadataClass, org.eclipse.persistence.internal.jpa.metadata.xml.XMLEntityMappings, org.eclipse.persistence.internal.sessions.AbstractSession
INTERNAL: Object to hold onto named native 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 MetadataClass
m_resultClass

private String
m_resultClassName

private String
m_resultSetMapping

Constructor Summary

AccessConstructor and Description
public
NamedNativeQueryMetadata()

INTERNAL: Used for XML loading.

public
NamedNativeQueryMetadata(MetadataAnnotation namedNativeQuery, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

protected
NamedNativeQueryMetadata(String javaClassName)

INTERNAL:

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
objectToCompare)

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

INTERNAL:
public MetadataClass
getResultClass()

INTERNAL:

public String
getResultClassName()

INTERNAL: Used for OX mapping.

public String
getResultSetMapping()

INTERNAL: Used for OX mapping.

public int
hashCode()

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

Returns a hash code value for the object.
protected boolean
hasResultSetMapping(AbstractSession session)

INTERNAL: Return true is a result set mapping has been specified.

public void
initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

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

INTERNAL:
public void
process(AbstractSession session)

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

INTERNAL:
public void
setResultClass(MetadataClass resultClass)

INTERNAL:

public void
setResultClassName(String resultClassName)

INTERNAL: Used for OX mapping.

public void
setResultSetMapping(String resultSetMapping)

INTERNAL: Used for OX mapping.

Inherited from org.eclipse.persistence.internal.jpa.metadata.queries.NamedQueryMetadata:
addJPAQuerygetHintsgetIdentifiergetLockModegetNamegetQueryprocessQueryHintssetHintssetLockModesetNamesetQuery

Field Detail

m_resultClassback to summary
private MetadataClass m_resultClass
m_resultClassNameback to summary
private String m_resultClassName
m_resultSetMappingback to summary
private String m_resultSetMapping

Constructor Detail

NamedNativeQueryMetadataback to summary
public NamedNativeQueryMetadata()

INTERNAL: Used for XML loading.

NamedNativeQueryMetadataback to summary
public NamedNativeQueryMetadata(MetadataAnnotation namedNativeQuery, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

NamedNativeQueryMetadataback to summary
protected NamedNativeQueryMetadata(String javaClassName)

INTERNAL:

Method Detail

equalsback to summary
public boolean equals(Object objectToCompare)

Overrides org.eclipse.persistence.internal.jpa.metadata.queries.NamedQueryMetadata.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
getResultClassback to summary
public MetadataClass getResultClass()

INTERNAL:

getResultClassNameback to summary
public String getResultClassName()

INTERNAL: Used for OX mapping.

getResultSetMappingback to summary
public String getResultSetMapping()

INTERNAL: Used for OX mapping.

hashCodeback to summary
public int hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.queries.NamedQueryMetadata.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
hasResultSetMappingback to summary
protected boolean hasResultSetMapping(AbstractSession session)

INTERNAL: Return true is a result set mapping has been specified.

initXMLObjectback to summary
public void initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

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

INTERNAL:

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

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

INTERNAL:

Annotations
@Override
setResultClassback to summary
public void setResultClass(MetadataClass resultClass)

INTERNAL:

setResultClassNameback to summary
public void setResultClassName(String resultClassName)

INTERNAL: Used for OX mapping.

setResultSetMappingback to summary
public void setResultSetMapping(String resultSetMapping)

INTERNAL: Used for OX mapping.