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

public Class NamedStoredProcedureQueryMetadata

extends NamedNativeQueryMetadata
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.metadata.queries.NamedStoredFunctionQueryMetadata
Imports
java.util.ArrayList, .List, 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, org.eclipse.persistence.queries.StoredProcedureCall
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.
Author
Guy Pelletier
Since
TopLink 11g

Field Summary

Modifier and TypeField and Description
private Boolean
m_callByIndex

private Boolean
m_multipleResultSets

private List<StoredProcedureParameterMetadata>
m_parameters

private String
m_procedureName

private List<MetadataClass>
m_resultClasses

private List<String>
m_resultClassNames

private List<String>
m_resultSetMappings

private Boolean
m_returnsResultSet

Constructor Summary

AccessConstructor and Description
public
NamedStoredProcedureQueryMetadata()

INTERNAL: Used for XML loading.

public
NamedStoredProcedureQueryMetadata(MetadataAnnotation namedStoredProcedureQuery, MetadataAccessor accessor)

INTERNAL:

public
NamedStoredProcedureQueryMetadata(String elementName)

INTERNAL: Used for XML loading.

Method Summary

Modifier and TypeMethod and Description
public boolean
callByIndex()

INTERNAL:

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

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

INTERNAL:
public Boolean
getCallByIndex()

INTERNAL: Used for OX mapping.

public Boolean
getMultipleResultSets()

INTERNAL: Used for OX mapping

public List<StoredProcedureParameterMetadata>
getParameters()

INTERNAL: Used for OX mapping.

public String
getProcedureName()

INTERNAL: Used for OX mapping.

public List<String>
getResultClassNames()

INTERNAL: Used for OX mapping.

public List<String>
getResultSetMappings()

INTERNAL: Used for OX mapping.

public Boolean
getReturnsResultSet()

INTERNAL: Used for OX mapping

public int
hashCode()

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

Returns a hash code value for the object.
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.

public void
initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

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

INTERNAL:
public void
process(AbstractSession session)

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

INTERNAL:
public boolean
returnsResultSet(boolean hasOutParameters)

INTERNAL: If there is no user setting and there are no out parameters, assume a result set is returned.

public void
setCallByIndex(Boolean callByIndex)

INTERNAL: Used for OX mapping.

public void
setMultipleResultSets(Boolean multipleResultSets)

INTERNAL: Used for OX mapping

public void
setParameters(List<StoredProcedureParameterMetadata> parameters)

INTERNAL: Used for OX mapping.

public void
setProcedureName(String procedureName)

INTERNAL: Used for OX mapping.

public void
setResultClassNames(List<String> resultClassNames)

INTERNAL: Used for OX mapping.

public void
setResultSetMappings(List<String> resultSetMappings)

INTERNAL: Used for OX mapping.

public void
setReturnsResultSet(Boolean returnsResultSet)

INTERNAL: Used for OX mapping.

Inherited from org.eclipse.persistence.internal.jpa.metadata.queries.NamedNativeQueryMetadata:
getResultClassgetResultClassNamegetResultSetMappinghasResultSetMappingsetResultClasssetResultClassNamesetResultSetMapping

Field Detail

m_callByIndexback to summary
private Boolean m_callByIndex
m_multipleResultSetsback to summary
private Boolean m_multipleResultSets
m_parametersback to summary
private List<StoredProcedureParameterMetadata> m_parameters
m_procedureNameback to summary
private String m_procedureName
m_resultClassesback to summary
private List<MetadataClass> m_resultClasses
m_resultClassNamesback to summary
private List<String> m_resultClassNames
m_resultSetMappingsback to summary
private List<String> m_resultSetMappings
m_returnsResultSetback to summary
private Boolean m_returnsResultSet

Constructor Detail

NamedStoredProcedureQueryMetadataback to summary
public NamedStoredProcedureQueryMetadata()

INTERNAL: Used for XML loading.

NamedStoredProcedureQueryMetadataback to summary
public NamedStoredProcedureQueryMetadata(MetadataAnnotation namedStoredProcedureQuery, MetadataAccessor accessor)

INTERNAL:

NamedStoredProcedureQueryMetadataback to summary
public NamedStoredProcedureQueryMetadata(String elementName)

INTERNAL: Used for XML loading.

Method Detail

callByIndexback to summary
public boolean callByIndex()

INTERNAL:

equalsback to summary
public boolean equals(Object objectToCompare)

Overrides org.eclipse.persistence.internal.jpa.metadata.queries.NamedNativeQueryMetadata.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
getCallByIndexback to summary
public Boolean getCallByIndex()

INTERNAL: Used for OX mapping.

getMultipleResultSetsback to summary
public Boolean getMultipleResultSets()

INTERNAL: Used for OX mapping

getParametersback to summary
public List<StoredProcedureParameterMetadata> getParameters()

INTERNAL: Used for OX mapping.

getProcedureNameback to summary
public String getProcedureName()

INTERNAL: Used for OX mapping.

getResultClassNamesback to summary
public List<String> getResultClassNames()

INTERNAL: Used for OX mapping.

getResultSetMappingsback to summary
public List<String> getResultSetMappings()

INTERNAL: Used for OX mapping.

getReturnsResultSetback to summary
public Boolean getReturnsResultSet()

INTERNAL: Used for OX mapping

hashCodeback to summary
public int hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.queries.NamedNativeQueryMetadata.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
hasMultipleResultSetsback to summary
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.

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

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

INTERNAL:

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

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

INTERNAL:

Annotations
@Override
returnsResultSetback to summary
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.

setCallByIndexback to summary
public void setCallByIndex(Boolean callByIndex)

INTERNAL: Used for OX mapping.

setMultipleResultSetsback to summary
public void setMultipleResultSets(Boolean multipleResultSets)

INTERNAL: Used for OX mapping

setParametersback to summary
public void setParameters(List<StoredProcedureParameterMetadata> parameters)

INTERNAL: Used for OX mapping.

setProcedureNameback to summary
public void setProcedureName(String procedureName)

INTERNAL: Used for OX mapping.

setResultClassNamesback to summary
public void setResultClassNames(List<String> resultClassNames)

INTERNAL: Used for OX mapping.

setResultSetMappingsback to summary
public void setResultSetMappings(List<String> resultSetMappings)

INTERNAL: Used for OX mapping.

setReturnsResultSetback to summary
public void setReturnsResultSet(Boolean returnsResultSet)

INTERNAL: Used for OX mapping.