Package org.eclipse.persistence.internal.helper

Class ComplexDatabaseType

java.lang.Object

org.eclipse.persistence.internal.helper.ComplexDatabaseType

All Implemented Interfaces:

java.lang.Cloneable, DatabaseType

Direct Known Subclasses:

OracleArrayType, OracleObjectType, PLSQLCollection, PLSQLCursor, PLSQLrecord

public abstract class ComplexDatabaseType
extends java.lang.Object
implements DatabaseType, java.lang.Cloneable

PUBLIC: Abstract class for Complex Database types (e.g. PL/SQL records, PL/SQL collections)

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

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	compatibleType
protected java.lang.Class	javaType	Defines the Java class that the complex type maps to.
protected java.lang.String	javaTypeName
protected java.lang.String	typeName

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

ARGNAME_SIZE_LIMIT, COMPAT_SHORT_PREFIX, COMPAT_SUFFIX, TARGET_SHORT_PREFIX, TARGET_SUFFIX

Constructor Summary

Constructors

Constructor	Description
ComplexDatabaseType()

Method Summary

Modifier and Type	Method	Description
void	buildBeginBlock(java.lang.StringBuilder sb, PLSQLargument arg, PLSQLStoredProcedureCall call)
void	buildInDeclare(java.lang.StringBuilder sb, PLSQLargument inArg)
void	buildOutAssignment(java.lang.StringBuilder sb, PLSQLargument outArg, PLSQLStoredProcedureCall call)
void	buildOutDeclare(java.lang.StringBuilder sb, PLSQLargument outArg)
void	buildOutputRow(PLSQLargument outArg, AbstractRecord outputRow, DatabaseRecord newOutputRow, java.util.List<DatabaseField> outputRowFields, java.util.List outputRowValues)
ComplexDatabaseType	clone()
int	computeInIndex(PLSQLargument inArg, int newIndex, java.util.ListIterator<PLSQLargument> i)
int	computeOutIndex(PLSQLargument outArg, int newIndex, java.util.ListIterator<PLSQLargument> i)
java.lang.String	getCompatibleType()
int	getConversionCode()
java.lang.Class	getJavaType()	Return the Java class that the complex type maps to.
java.lang.String	getJavaTypeName()
java.lang.String	getTypeName()
boolean	hasCompatibleType()
boolean	isArray()
boolean	isCollection()
boolean	isComplexDatabaseType()
boolean	isCursor()	Indicates if a given subclass represents a PL/SQL cursor.
boolean	isJDBCType()
boolean	isRecord()
boolean	isStruct()
void	logParameter(java.lang.StringBuilder sb, java.lang.Integer direction, PLSQLargument arg, AbstractRecord translationRow, DatabasePlatform platform)	Deprecated.
void	logParameter(java.lang.StringBuilder sb, DatasourceCall.ParameterType direction, PLSQLargument arg, AbstractRecord translationRow, DatabasePlatform platform)
void	setCompatibleType(java.lang.String compatibleType)
void	setJavaType(java.lang.Class javaType)	Set the Java class that the complex type maps to.
void	setJavaTypeName(java.lang.String javaTypeName)
void	setTypeName(java.lang.String typeName)
java.lang.String	toString()
void	translate(PLSQLargument arg, AbstractRecord translationRow, AbstractRecord copyOfTranslationRow, java.util.List<DatabaseField> copyOfTranslationFields, java.util.List<DatabaseField> translationRowFields, java.util.List translationRowValues, StoredProcedureCall call)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getSqlCode

Field Detail

typeName

protected java.lang.String typeName

compatibleType

protected java.lang.String compatibleType

javaType

protected java.lang.Class javaType

Defines the Java class that the complex type maps to.

javaTypeName

protected java.lang.String javaTypeName

Constructor Detail

ComplexDatabaseType

public ComplexDatabaseType()

Method Detail

isRecord

public boolean isRecord()

isCollection

public boolean isCollection()

isStruct

public boolean isStruct()

isArray

public boolean isArray()

isCursor

public boolean isCursor()

Indicates if a given subclass represents a PL/SQL cursor.

See Also:

PLSQLCursor

getConversionCode

public int getConversionCode()

Specified by:

getConversionCode in interface DatabaseType

isComplexDatabaseType

public boolean isComplexDatabaseType()

Specified by:

isComplexDatabaseType in interface DatabaseType

isJDBCType

public boolean isJDBCType()

Specified by:

isJDBCType in interface DatabaseType

hasCompatibleType

public boolean hasCompatibleType()

getCompatibleType

public java.lang.String getCompatibleType()

setCompatibleType

public void setCompatibleType(java.lang.String compatibleType)

getTypeName

public java.lang.String getTypeName()

Specified by:

getTypeName in interface DatabaseType

setTypeName

public void setTypeName(java.lang.String typeName)

setJavaType

public void setJavaType(java.lang.Class javaType)

Set the Java class that the complex type maps to. The mapped class for a Record type, and collection class for Collection type.

getJavaType

public java.lang.Class getJavaType()

Return the Java class that the complex type maps to.

getJavaTypeName

public java.lang.String getJavaTypeName()

setJavaTypeName

public void setJavaTypeName(java.lang.String javaTypeName)

clone

public ComplexDatabaseType clone()

Overrides:

clone in class java.lang.Object

buildInDeclare

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

Specified by:

buildInDeclare in interface DatabaseType

buildOutDeclare

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

Specified by:

buildOutDeclare in interface DatabaseType

buildBeginBlock

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

Specified by:

buildBeginBlock in interface DatabaseType

buildOutAssignment

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

Specified by:

buildOutAssignment in interface DatabaseType

buildOutputRow

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

Specified by:

buildOutputRow in interface DatabaseType

computeInIndex

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

Specified by:

computeInIndex in interface DatabaseType

computeOutIndex

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

Specified by:

computeOutIndex in interface DatabaseType

logParameter

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

Deprecated.

Specified by:

logParameter in interface DatabaseType

logParameter

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

Specified by:

logParameter 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)

Specified by:

translate in interface DatabaseType

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object