Module org.eclipse.persistence.jpa

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

Class NamedStoredProcedureQueryMetadata

java.lang.Object

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

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

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

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

Direct Known Subclasses:

NamedStoredFunctionQueryMetadata

public class NamedStoredProcedureQueryMetadata
extends NamedNativeQueryMetadata

INTERNAL: Object to hold onto a named stored procedure query. 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 11g

Author:

Guy Pelletier

Field Summary

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

m_project

Constructor Summary

Constructors

Constructor	Description
NamedStoredProcedureQueryMetadata()	INTERNAL: Used for XML loading.
NamedStoredProcedureQueryMetadata(String elementName)	INTERNAL: Used for XML loading.
NamedStoredProcedureQueryMetadata(MetadataAnnotation namedStoredProcedureQuery, MetadataAccessor accessor)	INTERNAL:

Method Summary

Modifier and Type	Method	Description
boolean	callByIndex()	INTERNAL:
boolean	equals(Object objectToCompare)	INTERNAL:
Boolean	getCallByIndex()	INTERNAL: Used for OX mapping.
Boolean	getMultipleResultSets()	INTERNAL: Used for OX mapping
List<StoredProcedureParameterMetadata>	getParameters()	INTERNAL: Used for OX mapping.
String	getProcedureName()	INTERNAL: Used for OX mapping.
List<String>	getResultClassNames()	INTERNAL: Used for OX mapping.
List<String>	getResultSetMappings()	INTERNAL: Used for OX mapping.
Boolean	getReturnsResultSet()	INTERNAL: Used for OX mapping
int	hashCode()
boolean	hasMultipleResultSets()	INTERNAL: If there is no user setting and there are not multiple result classes or result set mappings, assume a single result is returned.
void	initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)	INTERNAL:
void	process(AbstractSession session)	INTERNAL:
boolean	returnsResultSet(boolean hasOutParameters)	INTERNAL: If there is no user setting and there are no out parameters, assume a result set is returned.
void	setCallByIndex(Boolean callByIndex)	INTERNAL: Used for OX mapping.
void	setMultipleResultSets(Boolean multipleResultSets)	INTERNAL: Used for OX mapping
void	setParameters(List<StoredProcedureParameterMetadata> parameters)	INTERNAL: Used for OX mapping.
void	setProcedureName(String procedureName)	INTERNAL: Used for OX mapping.
void	setResultClassNames(List<String> resultClassNames)	INTERNAL: Used for OX mapping.
void	setResultSetMappings(List<String> resultSetMappings)	INTERNAL: Used for OX mapping.
void	setReturnsResultSet(Boolean returnsResultSet)	INTERNAL: Used for OX mapping.

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.queries.NamedNativeQueryMetadata

getResultClass, getResultClassName, getResultSetMapping, hasResultSetMapping, setResultClass, setResultClassName, setResultSetMapping

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.queries.NamedQueryMetadata

addJPAQuery, getHints, getIdentifier, getLockMode, getName, getQuery, processQueryHints, setHints, setLockMode, setName, setQuery

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 Detail

NamedStoredProcedureQueryMetadata

public NamedStoredProcedureQueryMetadata()

INTERNAL: Used for XML loading.

NamedStoredProcedureQueryMetadata

public NamedStoredProcedureQueryMetadata(MetadataAnnotation namedStoredProcedureQuery,
                                         MetadataAccessor accessor)

INTERNAL:

NamedStoredProcedureQueryMetadata

public NamedStoredProcedureQueryMetadata(String elementName)

INTERNAL: Used for XML loading.

Method Detail

callByIndex

public boolean callByIndex()

INTERNAL:

equals

public boolean equals(Object objectToCompare)

INTERNAL:

Overrides:

equals in class NamedNativeQueryMetadata

hashCode

public int hashCode()

Overrides:

hashCode in class NamedNativeQueryMetadata

getCallByIndex

public Boolean getCallByIndex()

INTERNAL: Used for OX mapping.

getMultipleResultSets

public Boolean getMultipleResultSets()

INTERNAL: Used for OX mapping

getParameters

public List<StoredProcedureParameterMetadata> getParameters()

INTERNAL: Used for OX mapping.

getProcedureName

public String getProcedureName()

INTERNAL: Used for OX mapping.

getResultClassNames

public List<String> getResultClassNames()

INTERNAL: Used for OX mapping.

getResultSetMappings

public List<String> getResultSetMappings()

INTERNAL: Used for OX mapping.

getReturnsResultSet

public Boolean getReturnsResultSet()

INTERNAL: Used for OX mapping

hasMultipleResultSets

public boolean hasMultipleResultSets()

INTERNAL: If there is no user setting and there are not multiple result classes or result set mappings, assume a single result is returned. There is no way to set this parameter via JPA, only through EclipseLink's metadata.

initXMLObject

public void initXMLObject(MetadataAccessibleObject accessibleObject,
                          XMLEntityMappings entityMappings)

INTERNAL:

Overrides:

initXMLObject in class NamedNativeQueryMetadata

process

public void process(AbstractSession session)

INTERNAL:

Overrides:

process in class NamedNativeQueryMetadata

returnsResultSet

public boolean returnsResultSet(boolean hasOutParameters)

INTERNAL: If there is no user setting and there are no out parameters, assume a result set is returned. There is no way to set this parameter via JPA, only through EclipseLink's metadata.

setCallByIndex

public void setCallByIndex(Boolean callByIndex)

INTERNAL: Used for OX mapping.

setMultipleResultSets

public void setMultipleResultSets(Boolean multipleResultSets)

INTERNAL: Used for OX mapping

setParameters

public void setParameters(List<StoredProcedureParameterMetadata> parameters)

INTERNAL: Used for OX mapping.

setProcedureName

public void setProcedureName(String procedureName)

INTERNAL: Used for OX mapping.

setResultClassNames

public void setResultClassNames(List<String> resultClassNames)

INTERNAL: Used for OX mapping.

setResultSetMappings

public void setResultSetMappings(List<String> resultSetMappings)

INTERNAL: Used for OX mapping.

setReturnsResultSet

public void setReturnsResultSet(Boolean returnsResultSet)

INTERNAL: Used for OX mapping.