Module org.eclipse.persistence.jpa

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

Class PLSQLParameterMetadata

java.lang.Object

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

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

public class PLSQLParameterMetadata
extends ORMetadata

INTERNAL: Object to hold onto a PLSQL parameter meta-data. 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:

EclipseLink 2.3

Author:

James Sutherland

Field Summary

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

m_project

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	INTERNAL:
String	getDatabaseType()	INTERNAL: Used for OX mapping.
protected DatabaseType	getDatabaseTypeEnum(String type)	Return the DataType enum constant for the String type name.
String	getDirection()	INTERNAL: Used for OX mapping.
Integer	getLength()	INTERNAL: Used for OX mapping.
String	getName()	INTERNAL: Used for OX mapping.
Boolean	getOptional()	INTERNAL: Used for OX mapping.
Integer	getPrecision()	INTERNAL: Used for OX mapping.
String	getQueryParameter()	INTERNAL: Used for OX mapping.
Integer	getScale()	INTERNAL: Used for OX mapping.
int	hashCode()
void	process(PLSQLStoredProcedureCall call, boolean functionReturn)	INTERNAL:
protected void	setDatabaseFieldSettings(DatabaseField field, MetadataProject project)	INTERNAL: set the project level settings on the database fields
void	setDatabaseType(String databaseType)	INTERNAL: Used for OX mapping.
void	setDirection(String direction)	INTERNAL: Used for OX mapping.
void	setLength(Integer length)	INTERNAL: Used for OX mapping.
void	setName(String name)	INTERNAL: Used for OX mapping.
void	setOptional(Boolean optional)	INTERNAL: Used for OX mapping.
void	setPrecision(Integer precision)	INTERNAL: Used for OX mapping.
void	setQueryParameter(String queryParameter)	INTERNAL: Used for OX mapping.
void	setScale(Integer scale)	INTERNAL: Used for OX mapping.

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

getAccessibleObject, getAccessibleObjectName, getAnnotation, getBoxedType, getEntityMappings, getFullyQualifiedClassName, getIdentifier, getJavaClass, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getName, getPrimitiveClassForName, getProject, getText, getXMLElement, hasIdentifier, hasText, initXMLClassName, initXMLObject, 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

PLSQLParameterMetadata

public PLSQLParameterMetadata()

INTERNAL: Used for XML loading.

PLSQLParameterMetadata

public PLSQLParameterMetadata(MetadataAnnotation storedProcedureParameter,
                              MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail

equals

public boolean equals(Object objectToCompare)

INTERNAL:

Specified by:

equals in class ORMetadata

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDatabaseType

public String getDatabaseType()

INTERNAL: Used for OX mapping.

getDatabaseTypeEnum

protected DatabaseType getDatabaseTypeEnum(String type)

Return the DataType enum constant for the String type name. If type is not a JDBCType, OraclePLSQLType, PLSQLCursor or a ComplexMetadataType, the type will be wrapped in a PLSQLrecord.

Overrides:

getDatabaseTypeEnum in class ORMetadata

getDirection

public String getDirection()

INTERNAL: Used for OX mapping.

getLength

public Integer getLength()

INTERNAL: Used for OX mapping.

getName

public String getName()

INTERNAL: Used for OX mapping.

getOptional

public Boolean getOptional()

INTERNAL: Used for OX mapping.

getPrecision

public Integer getPrecision()

INTERNAL: Used for OX mapping.

getQueryParameter

public String getQueryParameter()

INTERNAL: Used for OX mapping.

getScale

public Integer getScale()

INTERNAL: Used for OX mapping.

process

public void process(PLSQLStoredProcedureCall call,
                    boolean functionReturn)

INTERNAL:

setDatabaseFieldSettings

protected void setDatabaseFieldSettings(DatabaseField field,
                                        MetadataProject project)

INTERNAL: set the project level settings on the database fields

setDatabaseType

public void setDatabaseType(String databaseType)

INTERNAL: Used for OX mapping.

setDirection

public void setDirection(String direction)

INTERNAL: Used for OX mapping.

setLength

public void setLength(Integer length)

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.

setPrecision

public void setPrecision(Integer precision)

INTERNAL: Used for OX mapping.

setQueryParameter

public void setQueryParameter(String queryParameter)

INTERNAL: Used for OX mapping.

setScale

public void setScale(Integer scale)

INTERNAL: Used for OX mapping.