org.eclipse.persistence.platform.database.oracle.plsql

Enum OraclePLSQLTypes

java.lang.Object

java.lang.Enum<OraclePLSQLTypes>

org.eclipse.persistence.platform.database.oracle.plsql.OraclePLSQLTypes

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OraclePLSQLTypes>, DatabaseType, SimpleDatabaseType, OraclePLSQLType

public enum OraclePLSQLTypes
extends java.lang.Enum<OraclePLSQLTypes>
implements SimpleDatabaseType, OraclePLSQLType

PUBLIC: Oracle PL/SQL types

Since:

Oracle TopLink 11.x.x

Author:

Mike Norman - michael.norman@oracle.com

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.persistence.internal.helper.DatabaseType

DatabaseType.DatabaseTypeHelper

Enum Constant Summary

Enum Constants

Enum Constant and Description
BinaryInteger
Dec
Int
Natural
NaturalN
PLSQLBoolean
PLSQLInteger
Positive
PositiveN
SignType
XMLType

Field Summary

Fields inherited from interface org.eclipse.persistence.platform.database.oracle.plsql.OraclePLSQLType

PLSQLBoolean_IN_CONV, PLSQLBoolean_OUT_CONV

Fields inherited from interface org.eclipse.persistence.internal.helper.DatabaseType

ARGNAME_SIZE_LIMIT, COMPAT_SHORT_PREFIX, COMPAT_SUFFIX, TARGET_SHORT_PREFIX, TARGET_SUFFIX

Method Summary

Modifier and Type	Method and Description
void	buildBeginBlock(java.lang.StringBuilder sb, PLSQLargument arg, PLSQLStoredProcedureCall call) INTERNAL: Append any code or translation required for the type.
void	buildInDeclare(java.lang.StringBuilder sb, PLSQLargument inArg) INTERNAL: Append the variable declaration for the type.
void	buildOutAssignment(java.lang.StringBuilder sb, PLSQLargument arg, PLSQLStoredProcedureCall call) INTERNAL: Append any code or translation for assigning the output value.
void	buildOutDeclare(java.lang.StringBuilder sb, PLSQLargument outArg) INTERNAL: Append the variable declaration for the type.
void	buildOutputRow(PLSQLargument outArg, AbstractRecord outputRow, DatabaseRecord newOutputRow, java.util.List<DatabaseField> outputRowFields, java.util.List outputRowValues) INTERNAL: Build the query output row from the call output row.
int	computeInIndex(PLSQLargument inArg, int newIndex, java.util.ListIterator<PLSQLargument> i) INTERNAL: Return the parameter index for the IN parameter.
int	computeOutIndex(PLSQLargument outArg, int newIndex, java.util.ListIterator<PLSQLargument> i) INTERNAL: Return the parameter index for the OUT parameter.
int	getConversionCode()
static DatabaseType	getDatabaseTypeForCode(java.lang.String typeName)
int	getSqlCode()
java.lang.String	getTypeName()
boolean	isComplexDatabaseType()
boolean	isJDBCType()
void	logParameter(java.lang.StringBuilder sb, java.lang.Integer direction, PLSQLargument arg, AbstractRecord translationRow, DatabasePlatform platform) INTERNAL: Append the parameter for logging purposes.
void	translate(PLSQLargument arg, AbstractRecord translationRow, AbstractRecord copyOfTranslationRow, java.util.List<DatabaseField> copyOfTranslationFields, java.util.List<DatabaseField> translationRowFields, java.util.List translationRowValues, StoredProcedureCall call) INTERNAL: Translate the argument value from the query translation row to call translation row.
static OraclePLSQLTypes	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OraclePLSQLTypes[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BinaryInteger

public static final OraclePLSQLTypes BinaryInteger

Dec

public static final OraclePLSQLTypes Dec

Int

public static final OraclePLSQLTypes Int

Natural

public static final OraclePLSQLTypes Natural

NaturalN

public static final OraclePLSQLTypes NaturalN

PLSQLBoolean

public static final OraclePLSQLTypes PLSQLBoolean

PLSQLInteger

public static final OraclePLSQLTypes PLSQLInteger

Positive

public static final OraclePLSQLTypes Positive

PositiveN

public static final OraclePLSQLTypes PositiveN

SignType

public static final OraclePLSQLTypes SignType

XMLType

public static final OraclePLSQLTypes XMLType

Method Detail

values

public static OraclePLSQLTypes[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OraclePLSQLTypes c : OraclePLSQLTypes.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OraclePLSQLTypes valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isComplexDatabaseType

public boolean isComplexDatabaseType()

Specified by:

isComplexDatabaseType in interface DatabaseType

getSqlCode

public int getSqlCode()

Specified by:

getSqlCode in interface DatabaseType

getConversionCode

public int getConversionCode()

Specified by:

getConversionCode in interface DatabaseType

getTypeName

public java.lang.String getTypeName()

Specified by:

getTypeName in interface DatabaseType

isJDBCType

public boolean isJDBCType()

Specified by:

isJDBCType in interface DatabaseType

computeInIndex

public int computeInIndex(PLSQLargument inArg,
                          int newIndex,
                          java.util.ListIterator<PLSQLargument> i)

INTERNAL: Return the parameter index for the IN parameter.

Specified by:

computeInIndex in interface DatabaseType

computeOutIndex

public int computeOutIndex(PLSQLargument outArg,
                           int newIndex,
                           java.util.ListIterator<PLSQLargument> i)

INTERNAL: Return the parameter index for the OUT parameter.

Specified by:

computeOutIndex in interface DatabaseType

buildInDeclare

public void buildInDeclare(java.lang.StringBuilder sb,
                           PLSQLargument inArg)

INTERNAL: Append the variable declaration for the type.

Specified by:

buildInDeclare in interface DatabaseType

buildOutDeclare

public void buildOutDeclare(java.lang.StringBuilder sb,
                            PLSQLargument outArg)

INTERNAL: Append the variable declaration for the type.

Specified by:

buildOutDeclare in interface DatabaseType

buildBeginBlock

public void buildBeginBlock(java.lang.StringBuilder sb,
                            PLSQLargument arg,
                            PLSQLStoredProcedureCall call)

INTERNAL: Append any code or translation required for the type.

Specified by:

buildBeginBlock in interface DatabaseType

buildOutAssignment

public void buildOutAssignment(java.lang.StringBuilder sb,
                               PLSQLargument arg,
                               PLSQLStoredProcedureCall call)

INTERNAL: Append any code or translation for assigning the output value.

Specified by:

buildOutAssignment in interface DatabaseType

translate

public void translate(PLSQLargument arg,
                      AbstractRecord translationRow,
                      AbstractRecord copyOfTranslationRow,
                      java.util.List<DatabaseField> copyOfTranslationFields,
                      java.util.List<DatabaseField> translationRowFields,
                      java.util.List translationRowValues,
                      StoredProcedureCall call)

INTERNAL: Translate the argument value from the query translation row to call translation row.

Specified by:

translate in interface DatabaseType

buildOutputRow

public void buildOutputRow(PLSQLargument outArg,
                           AbstractRecord outputRow,
                           DatabaseRecord newOutputRow,
                           java.util.List<DatabaseField> outputRowFields,
                           java.util.List outputRowValues)

INTERNAL: Build the query output row from the call output row.

Specified by:

buildOutputRow in interface DatabaseType

logParameter

public void logParameter(java.lang.StringBuilder sb,
                         java.lang.Integer direction,
                         PLSQLargument arg,
                         AbstractRecord translationRow,
                         DatabasePlatform platform)

INTERNAL: Append the parameter for logging purposes.

Specified by:

logParameter in interface DatabaseType

getDatabaseTypeForCode

public static DatabaseType getDatabaseTypeForCode(java.lang.String typeName)