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

public Class NamedPLSQLStoredProcedureQueryMetadata

extends NamedNativeQueryMetadata
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.metadata.queries.NamedPLSQLStoredFunctionQueryMetadata
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, org.eclipse.persistence.internal.jpa.metadata.xml.XMLEntityMappings, org.eclipse.persistence.internal.sessions.AbstractSession, org.eclipse.persistence.platform.database.oracle.plsql.PLSQLStoredProcedureCall
INTERNAL: Object to hold onto a named PLSQL 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
James Sutherland
Since
EclipseLink 2.3

Field Summary

Modifier and TypeField and Description
private List<PLSQLParameterMetadata>
m_parameters

private String
m_procedureName

Constructor Summary

AccessConstructor and Description
public
NamedPLSQLStoredProcedureQueryMetadata()

INTERNAL: Used for XML loading.

public
NamedPLSQLStoredProcedureQueryMetadata(String elementName)

INTERNAL: Used for OX mapping.

public
NamedPLSQLStoredProcedureQueryMetadata(MetadataAnnotation namedStoredProcedureQuery, MetadataAccessor accessor)

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.NamedNativeQueryMetadata.equals.

INTERNAL:
public List<PLSQLParameterMetadata>
getParameters()

INTERNAL: Used for OX mapping.

public String
getProcedureName()

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 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 void
setParameters(List<PLSQLParameterMetadata> parameters)

INTERNAL: Used for OX mapping.

public void
setProcedureName(String procedureName)

INTERNAL: Used for OX mapping.

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

Field Detail

m_parametersback to summary
private List<PLSQLParameterMetadata> m_parameters
m_procedureNameback to summary
private String m_procedureName

Constructor Detail

NamedPLSQLStoredProcedureQueryMetadataback to summary
public NamedPLSQLStoredProcedureQueryMetadata()

INTERNAL: Used for XML loading.

NamedPLSQLStoredProcedureQueryMetadataback to summary
public NamedPLSQLStoredProcedureQueryMetadata(String elementName)

INTERNAL: Used for OX mapping.

NamedPLSQLStoredProcedureQueryMetadataback to summary
public NamedPLSQLStoredProcedureQueryMetadata(MetadataAnnotation namedStoredProcedureQuery, MetadataAccessor accessor)

INTERNAL:

Method Detail

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
getParametersback to summary
public List<PLSQLParameterMetadata> getParameters()

INTERNAL: Used for OX mapping.

getProcedureNameback to summary
public String getProcedureName()

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
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
setParametersback to summary
public void setParameters(List<PLSQLParameterMetadata> parameters)

INTERNAL: Used for OX mapping.

setProcedureNameback to summary
public void setProcedureName(String procedureName)

INTERNAL: Used for OX mapping.