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

public Class PLSQLParameterMetadata

extends ORMetadata
Class Inheritance
Imports
org.eclipse.persistence.annotations.Direction, org.eclipse.persistence.internal.databaseaccess.DatasourceCall, .DatasourceCall.ParameterType, org.eclipse.persistence.internal.helper.DatabaseField, .DatabaseType, org.eclipse.persistence.internal.jpa.metadata.MetadataProject, .ORMetadata, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotation, org.eclipse.persistence.platform.database.oracle.plsql.PLSQLCursor, .PLSQLStoredFunctionCall, .PLSQLStoredProcedureCall
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.
Author
James Sutherland
Since
EclipseLink 2.3

Field Summary

Modifier and TypeField and Description
private String
m_databaseType

private String
m_direction

private Integer
m_length

private String
m_name

private Boolean
m_optional

private Integer
m_precision

private String
m_queryParameter

private Integer
m_scale

Inherited from org.eclipse.persistence.internal.jpa.metadata.ORMetadata:
m_project

Constructor Summary

AccessConstructor and Description
public
PLSQLParameterMetadata()

INTERNAL: Used for XML loading.

public
PLSQLParameterMetadata(MetadataAnnotation storedProcedureParameter, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
objectToCompare)

Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals.

INTERNAL:
public String
getDatabaseType()

INTERNAL: Used for OX mapping.

protected DatabaseType
getDatabaseTypeEnum(String type)

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

Return the DataType enum constant for the String type name.
public String
getDirection()

INTERNAL: Used for OX mapping.

public Integer
getLength()

INTERNAL: Used for OX mapping.

public String
getName()

INTERNAL: Used for OX mapping.

public Boolean
getOptional()

INTERNAL: Used for OX mapping.

public Integer
getPrecision()

INTERNAL: Used for OX mapping.

public String
getQueryParameter()

INTERNAL: Used for OX mapping.

public Integer
getScale()

INTERNAL: Used for OX mapping.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public void
process(PLSQLStoredProcedureCall call, boolean functionReturn)

INTERNAL:

protected void
setDatabaseFieldSettings(DatabaseField field, MetadataProject project)

INTERNAL: set the project level settings on the database fields

public void
setDatabaseType(String databaseType)

INTERNAL: Used for OX mapping.

public void
setDirection(String direction)

INTERNAL: Used for OX mapping.

public void
setLength(Integer length)

INTERNAL: Used for OX mapping.

public void
setName(String name)

INTERNAL: Used for OX mapping.

public void
setOptional(Boolean optional)

INTERNAL: Used for OX mapping.

public void
setPrecision(Integer precision)

INTERNAL: Used for OX mapping.

public void
setQueryParameter(String queryParameter)

INTERNAL: Used for OX mapping.

public void
setScale(Integer scale)

INTERNAL: Used for OX mapping.

Inherited from org.eclipse.persistence.internal.jpa.metadata.ORMetadata:
getAccessibleObjectgetAccessibleObjectNamegetAnnotationgetBoxedTypegetEntityMappingsgetFullyQualifiedClassNamegetIdentifiergetJavaClassgetJavaClassNamegetLoadergetLocationgetLoggergetMetadataClassgetMetadataClassgetMetadataClassgetMetadataFactorygetNamegetPrimitiveClassForNamegetProjectgetTextgetXMLElementhasIdentifierhasTextinitXMLClassNameinitXMLObjectinitXMLObjectinitXMLObjectsinitXMLTextObjectloadedFromAnnotationloadedFromEclipseLinkXMLloadedFromXMLmergemergeORObjectListsmergeORObjectsmergeSimpleObjectsreloadEntityreloadMappedSuperclasssetAccessibleObjectsetEntityMappingssetFieldNamesetFieldNamesetProjectshouldOverridevaluesMatchvaluesMatch

Field Detail

m_databaseTypeback to summary
private String m_databaseType
m_directionback to summary
private String m_direction
m_lengthback to summary
private Integer m_length
m_nameback to summary
private String m_name
m_optionalback to summary
private Boolean m_optional
m_precisionback to summary
private Integer m_precision
m_queryParameterback to summary
private String m_queryParameter
m_scaleback to summary
private Integer m_scale

Constructor Detail

PLSQLParameterMetadataback to summary
public PLSQLParameterMetadata()

INTERNAL: Used for XML loading.

PLSQLParameterMetadataback to summary
public PLSQLParameterMetadata(MetadataAnnotation storedProcedureParameter, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail

equalsback to summary
public boolean equals(Object objectToCompare)

Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.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
getDatabaseTypeback to summary
public String getDatabaseType()

INTERNAL: Used for OX mapping.

getDatabaseTypeEnumback to summary
protected DatabaseType getDatabaseTypeEnum(String type)

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

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.

Annotations
@Override
getDirectionback to summary
public String getDirection()

INTERNAL: Used for OX mapping.

getLengthback to summary
public Integer getLength()

INTERNAL: Used for OX mapping.

getNameback to summary
public String getName()

INTERNAL: Used for OX mapping.

getOptionalback to summary
public Boolean getOptional()

INTERNAL: Used for OX mapping.

getPrecisionback to summary
public Integer getPrecision()

INTERNAL: Used for OX mapping.

getQueryParameterback to summary
public String getQueryParameter()

INTERNAL: Used for OX mapping.

getScaleback to summary
public Integer getScale()

INTERNAL: Used for OX mapping.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.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
processback to summary
public void process(PLSQLStoredProcedureCall call, boolean functionReturn)

INTERNAL:

setDatabaseFieldSettingsback to summary
protected void setDatabaseFieldSettings(DatabaseField field, MetadataProject project)

INTERNAL: set the project level settings on the database fields

setDatabaseTypeback to summary
public void setDatabaseType(String databaseType)

INTERNAL: Used for OX mapping.

setDirectionback to summary
public void setDirection(String direction)

INTERNAL: Used for OX mapping.

setLengthback to summary
public void setLength(Integer length)

INTERNAL: Used for OX mapping.

setNameback to summary
public void setName(String name)

INTERNAL: Used for OX mapping.

setOptionalback to summary
public void setOptional(Boolean optional)

INTERNAL: Used for OX mapping.

setPrecisionback to summary
public void setPrecision(Integer precision)

INTERNAL: Used for OX mapping.

setQueryParameterback to summary
public void setQueryParameter(String queryParameter)

INTERNAL: Used for OX mapping.

setScaleback to summary
public void setScale(Integer scale)

INTERNAL: Used for OX mapping.