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

public Class StoredProcedureParameterMetadata

extends ORMetadata
Class Inheritance
Static Imports
java.sql.Types.STRUCT, org.eclipse.persistence.internal.jpa.metadata.MetadataConstants.JPA_PARAMETER_IN, .MetadataConstants.JPA_PARAMETER_INOUT, .MetadataConstants.JPA_PARAMETER_OUT, .MetadataConstants.JPA_PARAMETER_REF_CURSOR
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.
Author
Guy Pelletier
Since
TopLink 11g

Field Summary

Modifier and TypeField and Description
private String
m_direction

private Integer
m_jdbcType

private String
m_jdbcTypeName

private String
m_mode

private String
m_name

private Boolean
m_optional

private String
m_queryParameter

private MetadataClass
m_type

private String
m_typeName

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

Constructor Summary

AccessConstructor and Description
public
StoredProcedureParameterMetadata()

INTERNAL: Used for XML loading.

public
StoredProcedureParameterMetadata(MetadataAnnotation storedProcedureParameter, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Summary

Modifier and TypeMethod and Description
protected ObjectRelationalDatabaseField

Returns:

an ObjectRelationalDatabaseField instance
buildNestedField(OracleArrayTypeMetadata
OracleArrayTypeMetadata instance to be used to construct the field
aType)

Builds an ObjectRelationalDatabaseField based on a given OracleArrayTypeMetadata instance.

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

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

INTERNAL:
protected OracleArrayTypeMetadata

Returns:

the OracleArrayTypeMetadata instance with javaType matching javaClassName, or null if none exists.
getArrayTypeMetadata(String
class name used to look up the OracleArrayTypeMetadata instance
javaClassName)

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

public String
getDirection()

INTERNAL: Used for OX mapping.

public Integer
getJdbcType()

INTERNAL: Used for OX mapping.

public String
getJdbcTypeName()

INTERNAL: Used for OX mapping.

public String
getMode()

INTERNAL: Used for OX mapping.

public String
getName()

INTERNAL: Used for OX mapping.

public Boolean
getOptional()

INTERNAL: Used for OX mapping.

public String
getQueryParameter()

INTERNAL: Used for OX mapping.

public MetadataClass
getType()

INTERNAL:

public String
getTypeName()

INTERNAL: Used for OX mapping.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
protected boolean
hasJdbcType()

INTERNAL:

protected boolean
hasJdbcTypeName()

INTERNAL:

protected boolean
hasType()

INTERNAL:

protected boolean
hasTypeName()

INTERNAL:

public void
initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

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

INTERNAL:
public boolean
isOutParameter()

INTERNAL:

private boolean
process(StoredProcedureCall call, int index)

INTERNAL:

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

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

public void
processResult(StoredFunctionCall call, int index)

INTERNAL:

protected void
setDatabaseFieldSettings(DatabaseField field)

INTERNAL: set the project level settings on the database fields

public void
setDirection(String direction)

INTERNAL: Used for OX mapping.

public void
setJdbcType(Integer jdbcType)

INTERNAL: Used for OX mapping.

public void
setJdbcTypeName(String jdbcTypeName)

INTERNAL: Used for OX mapping.

public void
setMode(String mode)

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
setQueryParameter(String queryParameter)

INTERNAL: Used for OX mapping.

public void
setType(MetadataClass type)

INTERNAL:

public void
setTypeName(String typeName)

INTERNAL: Used for OX mapping.

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

Field Detail

m_directionback to summary
private String m_direction
m_jdbcTypeback to summary
private Integer m_jdbcType
m_jdbcTypeNameback to summary
private String m_jdbcTypeName
m_modeback to summary
private String m_mode
m_nameback to summary
private String m_name
m_optionalback to summary
private Boolean m_optional
m_queryParameterback to summary
private String m_queryParameter
m_typeback to summary
private MetadataClass m_type
m_typeNameback to summary
private String m_typeName

Constructor Detail

StoredProcedureParameterMetadataback to summary
public StoredProcedureParameterMetadata()

INTERNAL: Used for XML loading.

StoredProcedureParameterMetadataback to summary
public StoredProcedureParameterMetadata(MetadataAnnotation storedProcedureParameter, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail

buildNestedFieldback to summary
protected ObjectRelationalDatabaseField buildNestedField(OracleArrayTypeMetadata aType)

Builds an ObjectRelationalDatabaseField based on a given OracleArrayTypeMetadata instance.

Parameters
aType:OracleArrayTypeMetadata

OracleArrayTypeMetadata instance to be used to construct the field

Returns:ObjectRelationalDatabaseField

an ObjectRelationalDatabaseField instance

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
getArrayTypeMetadataback to summary
protected OracleArrayTypeMetadata getArrayTypeMetadata(String javaClassName)

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

Parameters
javaClassName:String

class name used to look up the OracleArrayTypeMetadata instance

Returns:OracleArrayTypeMetadata

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

getDirectionback to summary
public String getDirection()

INTERNAL: Used for OX mapping.

getJdbcTypeback to summary
public Integer getJdbcType()

INTERNAL: Used for OX mapping.

getJdbcTypeNameback to summary
public String getJdbcTypeName()

INTERNAL: Used for OX mapping.

getModeback to summary
public String getMode()

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.

getQueryParameterback to summary
public String getQueryParameter()

INTERNAL: Used for OX mapping.

getTypeback to summary
public MetadataClass getType()

INTERNAL:

getTypeNameback to summary
public String getTypeName()

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
hasJdbcTypeback to summary
protected boolean hasJdbcType()

INTERNAL:

hasJdbcTypeNameback to summary
protected boolean hasJdbcTypeName()

INTERNAL:

hasTypeback to summary
protected boolean hasType()

INTERNAL:

hasTypeNameback to summary
protected boolean hasTypeName()

INTERNAL:

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

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

INTERNAL:

Annotations
@Override
isOutParameterback to summary
public boolean isOutParameter()

INTERNAL:

processback to summary
private boolean process(StoredProcedureCall call, int index)

INTERNAL:

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

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

processResultback to summary
public void processResult(StoredFunctionCall call, int index)

INTERNAL:

setDatabaseFieldSettingsback to summary
protected void setDatabaseFieldSettings(DatabaseField field)

INTERNAL: set the project level settings on the database fields

setDirectionback to summary
public void setDirection(String direction)

INTERNAL: Used for OX mapping.

setJdbcTypeback to summary
public void setJdbcType(Integer jdbcType)

INTERNAL: Used for OX mapping.

setJdbcTypeNameback to summary
public void setJdbcTypeName(String jdbcTypeName)

INTERNAL: Used for OX mapping.

setModeback to summary
public void setMode(String mode)

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.

setQueryParameterback to summary
public void setQueryParameter(String queryParameter)

INTERNAL: Used for OX mapping.

setTypeback to summary
public void setType(MetadataClass type)

INTERNAL:

setTypeNameback to summary
public void setTypeName(String typeName)

INTERNAL: Used for OX mapping.