Module org.eclipse.persistence.jpa

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

Class StoredProcedureParameterMetadata

java.lang.Object

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

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

public class StoredProcedureParameterMetadata
extends ORMetadata

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

Author:

Guy Pelletier

Field Summary

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

m_project

Constructor Summary

Constructors

Constructor	Description
StoredProcedureParameterMetadata()	INTERNAL: Used for XML loading.
StoredProcedureParameterMetadata(MetadataAnnotation storedProcedureParameter, MetadataAccessor accessor)	INTERNAL: Used for annotation loading.

Method Summary

Modifier and Type	Method	Description
protected ObjectRelationalDatabaseField	buildNestedField(OracleArrayTypeMetadata aType)	Builds an ObjectRelationalDatabaseField based on a given OracleArrayTypeMetadata instance.
boolean	equals(Object objectToCompare)	INTERNAL:
protected OracleArrayTypeMetadata	getArrayTypeMetadata(String javaClassName)	Returns the OracleArrayTypeMetadata instance for a given class name, or null if none exists.
String	getDirection()	INTERNAL: Used for OX mapping.
Integer	getJdbcType()	INTERNAL: Used for OX mapping.
String	getJdbcTypeName()	INTERNAL: Used for OX mapping.
String	getMode()	INTERNAL: Used for OX mapping.
String	getName()	INTERNAL: Used for OX mapping.
Boolean	getOptional()	INTERNAL: Used for OX mapping.
String	getQueryParameter()	INTERNAL: Used for OX mapping.
MetadataClass	getType()	INTERNAL:
String	getTypeName()	INTERNAL: Used for OX mapping.
int	hashCode()
protected boolean	hasJdbcType()	INTERNAL:
protected boolean	hasJdbcTypeName()	INTERNAL:
protected boolean	hasType()	INTERNAL:
protected boolean	hasTypeName()	INTERNAL:
void	initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)	INTERNAL:
boolean	isOutParameter()	INTERNAL:
void	processArgument(StoredProcedureCall call, boolean callByIndex, int index)	INTERNAL: #Bug 533272 - JPA NamedStoredProcedure call getOutputParameterValue with parameter name cause exception
void	processResult(StoredFunctionCall call, int index)	INTERNAL:
protected void	setDatabaseFieldSettings(DatabaseField field)	INTERNAL: set the project level settings on the database fields
void	setDirection(String direction)	INTERNAL: Used for OX mapping.
void	setJdbcType(Integer jdbcType)	INTERNAL: Used for OX mapping.
void	setJdbcTypeName(String jdbcTypeName)	INTERNAL: Used for OX mapping.
void	setMode(String mode)	INTERNAL: Used for OX mapping.
void	setName(String name)	INTERNAL: Used for OX mapping.
void	setOptional(Boolean optional)	INTERNAL: Used for OX mapping.
void	setQueryParameter(String queryParameter)	INTERNAL: Used for OX mapping.
void	setType(MetadataClass type)	INTERNAL:
void	setTypeName(String typeName)	INTERNAL: Used for OX mapping.

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

getAccessibleObject, getAccessibleObjectName, getAnnotation, getBoxedType, getDatabaseTypeEnum, getEntityMappings, getFullyQualifiedClassName, getIdentifier, 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

StoredProcedureParameterMetadata

public StoredProcedureParameterMetadata()

INTERNAL: Used for XML loading.

StoredProcedureParameterMetadata

public StoredProcedureParameterMetadata(MetadataAnnotation storedProcedureParameter,
                                        MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail

buildNestedField

protected ObjectRelationalDatabaseField buildNestedField(OracleArrayTypeMetadata aType)

Builds an ObjectRelationalDatabaseField based on a given OracleArrayTypeMetadata instance.

Parameters:

aType - OracleArrayTypeMetadata instance to be used to construct the field

Returns:

an ObjectRelationalDatabaseField instance

equals

public boolean equals(Object objectToCompare)

INTERNAL:

Specified by:

equals in class ORMetadata

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getArrayTypeMetadata

protected OracleArrayTypeMetadata getArrayTypeMetadata(String javaClassName)

Returns the OracleArrayTypeMetadata instance for a given class name, or null if none exists.

Parameters:

javaClassName - class name used to look up the OracleArrayTypeMetadata instance

Returns:

the OracleArrayTypeMetadata instance with javaType matching javaClassName, or null if none exists.

getDirection

public String getDirection()

INTERNAL: Used for OX mapping.

getJdbcType

public Integer getJdbcType()

INTERNAL: Used for OX mapping.

getJdbcTypeName

public String getJdbcTypeName()

INTERNAL: Used for OX mapping.

getMode

public String getMode()

INTERNAL: Used for OX mapping.

getName

public String getName()

INTERNAL: Used for OX mapping.

getOptional

public Boolean getOptional()

INTERNAL: Used for OX mapping.

getQueryParameter

public String getQueryParameter()

INTERNAL: Used for OX mapping.

getType

public MetadataClass getType()

INTERNAL:

getTypeName

public String getTypeName()

INTERNAL: Used for OX mapping.

hasJdbcType

protected boolean hasJdbcType()

INTERNAL:

hasJdbcTypeName

protected boolean hasJdbcTypeName()

INTERNAL:

hasType

protected boolean hasType()

INTERNAL:

hasTypeName

protected boolean hasTypeName()

INTERNAL:

initXMLObject

public void initXMLObject(MetadataAccessibleObject accessibleObject,
                          XMLEntityMappings entityMappings)

INTERNAL:

Overrides:

initXMLObject in class ORMetadata

isOutParameter

public boolean isOutParameter()

INTERNAL:

processArgument

public void processArgument(StoredProcedureCall call,
                            boolean callByIndex,
                            int index)

INTERNAL: #Bug 533272 - JPA NamedStoredProcedure call getOutputParameterValue with parameter name cause exception

processResult

public void processResult(StoredFunctionCall call,
                          int index)

INTERNAL:

setDatabaseFieldSettings

protected void setDatabaseFieldSettings(DatabaseField field)

INTERNAL: set the project level settings on the database fields

setDirection

public void setDirection(String direction)

INTERNAL: Used for OX mapping.

setJdbcType

public void setJdbcType(Integer jdbcType)

INTERNAL: Used for OX mapping.

setJdbcTypeName

public void setJdbcTypeName(String jdbcTypeName)

INTERNAL: Used for OX mapping.

setMode

public void setMode(String mode)

INTERNAL: Used for OX mapping.

setName

public void setName(String name)

INTERNAL: Used for OX mapping.

setOptional

public void setOptional(Boolean optional)

INTERNAL: Used for OX mapping.

setQueryParameter

public void setQueryParameter(String queryParameter)

INTERNAL: Used for OX mapping.

setType

public void setType(MetadataClass type)

INTERNAL:

setTypeName

public void setTypeName(String typeName)

INTERNAL: Used for OX mapping.