Top Description Fields Constructors Methods
org.eclipse.persistence.platform.database.oracle.plsql

public Class PLSQLrecord

extends ComplexDatabaseType
implements OraclePLSQLType, Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable, org.eclipse.persistence.platform.database.oracle.plsql.OraclePLSQLType, org.eclipse.persistence.internal.helper.SimpleDatabaseType, org.eclipse.persistence.internal.helper.DatabaseType
Static Imports
java.sql.Types.OTHER, .Types.STRUCT, org.eclipse.persistence.internal.helper.DatabaseType.DatabaseTypeHelper.databaseTypeHelper
PUBLIC: describe an Oracle PL/SQL Record type
Author
Mike Norman - [email protected]
Since
Oracle TopLink 11.x.x

Field Summary

Modifier and TypeField and Description
protected List<PLSQLargument>
fields

Inherited from org.eclipse.persistence.internal.helper.ComplexDatabaseType:
compatibleTypejavaTypejavaTypeNametypeName

Constructor Summary

AccessConstructor and Description
public
PLSQLrecord()

Method Summary

Modifier and TypeMethod and Description
public void
addField(PLSQLargument field)

public void
addField(String fieldName, DatabaseType databaseType)

public void
addField(String fieldName, DatabaseType databaseType, int precision, int scale)

public void
addField(String fieldName, DatabaseType databaseType, int length)

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

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.buildBeginBlock.

Implements org.eclipse.persistence.internal.helper.DatabaseType.buildBeginBlock.

public void
buildInDeclare(StringBuilder sb, PLSQLargument inArg)

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.buildInDeclare.

Implements org.eclipse.persistence.internal.helper.DatabaseType.buildInDeclare.

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

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.buildOutAssignment.

Implements org.eclipse.persistence.internal.helper.DatabaseType.buildOutAssignment.

public void
buildOutDeclare(StringBuilder sb, PLSQLargument outArg)

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.buildOutDeclare.

Implements org.eclipse.persistence.internal.helper.DatabaseType.buildOutDeclare.

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

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.buildOutputRow.

Implements org.eclipse.persistence.internal.helper.DatabaseType.buildOutputRow.

public PLSQLrecord
clone()

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.clone.

Creates and returns a copy of this object.
public int
computeInIndex(PLSQLargument inArg, int newIndex, ListIterator<PLSQLargument> iterator)

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.computeInIndex.

Implements org.eclipse.persistence.internal.helper.DatabaseType.computeInIndex.

public int
computeOutIndex(PLSQLargument outArg, int newIndex, ListIterator<PLSQLargument> iterator)

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.computeOutIndex.

Implements org.eclipse.persistence.internal.helper.DatabaseType.computeOutIndex.

public List<PLSQLargument>
getFields()

Return the record's fields defined as PLSQLargument.

public int
getSqlCode()

Implements org.eclipse.persistence.internal.helper.DatabaseType.getSqlCode.

public boolean
isRecord()

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.isRecord.

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

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.logParameter.

Implements org.eclipse.persistence.internal.helper.DatabaseType.logParameter.

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

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.translate.

Implements org.eclipse.persistence.internal.helper.DatabaseType.translate.

Inherited from org.eclipse.persistence.internal.helper.ComplexDatabaseType:
getCompatibleTypegetConversionCodegetJavaTypegetJavaTypeNamegetTypeNamehasCompatibleTypeisArrayisCollectionisComplexDatabaseTypeisCursorisJDBCTypeisStructsetCompatibleTypesetJavaTypesetJavaTypeNamesetTypeNametoString

Field Detail

fieldsback to summary
protected List<PLSQLargument> fields

Constructor Detail

PLSQLrecordback to summary
public PLSQLrecord()

Method Detail

addFieldback to summary
public void addField(PLSQLargument field)
addFieldback to summary
public void addField(String fieldName, DatabaseType databaseType)
addFieldback to summary
public void addField(String fieldName, DatabaseType databaseType, int precision, int scale)
addFieldback to summary
public void addField(String fieldName, DatabaseType databaseType, int length)
buildBeginBlockback to summary
public void buildBeginBlock(StringBuilder sb, PLSQLargument arg, PLSQLStoredProcedureCall call)

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.buildBeginBlock.

Implements org.eclipse.persistence.internal.helper.DatabaseType.buildBeginBlock.

Annotations
@Override
buildInDeclareback to summary
public void buildInDeclare(StringBuilder sb, PLSQLargument inArg)

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.buildInDeclare.

Implements org.eclipse.persistence.internal.helper.DatabaseType.buildInDeclare.

Annotations
@Override
buildOutAssignmentback to summary
public void buildOutAssignment(StringBuilder sb, PLSQLargument outArg, PLSQLStoredProcedureCall call)

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.buildOutAssignment.

Implements org.eclipse.persistence.internal.helper.DatabaseType.buildOutAssignment.

Annotations
@Override
buildOutDeclareback to summary
public void buildOutDeclare(StringBuilder sb, PLSQLargument outArg)

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.buildOutDeclare.

Implements org.eclipse.persistence.internal.helper.DatabaseType.buildOutDeclare.

Annotations
@Override
buildOutputRowback to summary
public void buildOutputRow(PLSQLargument outArg, AbstractRecord outputRow, DatabaseRecord newOutputRow, List<DatabaseField> outputRowFields, List<E> outputRowValues)

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.buildOutputRow.

Implements org.eclipse.persistence.internal.helper.DatabaseType.buildOutputRow.

Annotations
@Override
cloneback to summary
public PLSQLrecord clone()

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression: 

x.clone() != x
will be true, and that the expression: 
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that: 
x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:PLSQLrecord

a clone of this instance.

Annotations
@Override
computeInIndexback to summary
public int computeInIndex(PLSQLargument inArg, int newIndex, ListIterator<PLSQLargument> iterator)

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.computeInIndex.

Implements org.eclipse.persistence.internal.helper.DatabaseType.computeInIndex.

Annotations
@Override
computeOutIndexback to summary
public int computeOutIndex(PLSQLargument outArg, int newIndex, ListIterator<PLSQLargument> iterator)

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.computeOutIndex.

Implements org.eclipse.persistence.internal.helper.DatabaseType.computeOutIndex.

Annotations
@Override
getFieldsback to summary
public List<PLSQLargument> getFields()

Return the record's fields defined as PLSQLargument.

getSqlCodeback to summary
public int getSqlCode()

Implements org.eclipse.persistence.internal.helper.DatabaseType.getSqlCode.

Annotations
@Override
isRecordback to summary
public boolean isRecord()

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.isRecord.

Annotations
@Override
logParameterback to summary
public void logParameter(StringBuilder sb, DatasourceCall.ParameterType direction, PLSQLargument arg, AbstractRecord translationRow, DatabasePlatform platform)

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.logParameter.

Implements org.eclipse.persistence.internal.helper.DatabaseType.logParameter.

Annotations
@Override
translateback to summary
public void translate(PLSQLargument arg, AbstractRecord translationRow, AbstractRecord copyOfTranslationRow, List<DatabaseField> copyOfTranslationFields, List<DatabaseField> translationRowFields, List<E> translationRowValues, StoredProcedureCall call)

Overrides org.eclipse.persistence.internal.helper.ComplexDatabaseType.translate.

Implements org.eclipse.persistence.internal.helper.DatabaseType.translate.

Annotations
@Override