Module org.datanucleus.store.rdbms

Package org.datanucleus.store.rdbms.mapping.java

Class SQLFunctionMapping

java.lang.Object

org.datanucleus.store.rdbms.mapping.java.JavaTypeMapping

org.datanucleus.store.rdbms.mapping.java.SingleFieldMapping

org.datanucleus.store.rdbms.mapping.java.SQLFunctionMapping

public class SQLFunctionMapping
extends SingleFieldMapping

Mapping to represent the return value of an SQL function invocation. With a generalised SQL function call we do not know the type of the function result, so only create the datastore mapping on processing of the first result.

Field Summary

Fields inherited from class org.datanucleus.store.rdbms.mapping.java.SingleFieldMapping

EXTENSION_CHECK_CONSTRAINT_VALUES

Fields inherited from class org.datanucleus.store.rdbms.mapping.java.JavaTypeMapping

absFieldNumber, columnMappings, mmd, referenceMapping, roleForMember, storeMgr, table, type

Constructor Summary

Constructors

Constructor	Description
SQLFunctionMapping()

Method Summary

Modifier and Type	Method	Description
Class	getJavaType()	Accessor for the java type being mapped.
Object	getObject(org.datanucleus.ExecutionContext ec, ResultSet resultSet, int[] exprIndex)	Obtains a value from datastoreResults at position specified by exprIndex.
protected void	prepareColumnMapping()	Method to prepare a column mapping for use in the datastore.

Methods inherited from class org.datanucleus.store.rdbms.mapping.java.SingleFieldMapping

getBoolean, getByte, getChar, getDefaultLength, getDouble, getFloat, getInt, getJavaTypeForColumnMapping, getLong, getShort, getString, getValidValues, initialize, setBoolean, setByte, setChar, setDouble, setFloat, setInt, setLong, setObject, setShort, setString

Methods inherited from class org.datanucleus.store.rdbms.mapping.java.JavaTypeMapping

addColumnMapping, equals, failureMessage, getAbsoluteFieldNumber, getColumnMapping, getColumnMappings, getColumnMetaDataForMember, getMemberMetaData, getNumberOfColumnMappings, getObject, getReferenceMapping, getRoleForMember, getStoreManager, getTable, getType, getValueForColumnMapping, hashCode, hasSimpleDatastoreRepresentation, includeInFetchStatement, includeInInsertStatement, includeInUpdateStatement, initialize, isNullable, isSerialised, performSetPostProcessing, representableAsStringLiteralInStatement, requiresSetPostProcessing, setAbsFieldNumber, setMemberMetaData, setObject, setReferenceMapping, setRoleForMember, setTable

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SQLFunctionMapping

public SQLFunctionMapping()

Method Detail

getJavaType

public Class getJavaType()

Description copied from class: JavaTypeMapping

Accessor for the java type being mapped. This is the java type that the mapping represents. Some examples :

• if the field is of type "MyClass" then the mapping will be OIDMapping (or subclass) the javaType will be OID, and the type will be MyClass.
• if the field is of type "int" then the mapping will be IntegerMapping, the javaType will be Integer, and the type will be int.

The "java type" is the java-type name used in the plugin.xml mapping file

Specified by:

getJavaType in class JavaTypeMapping

Returns:

The java type

prepareColumnMapping

protected void prepareColumnMapping()

Method to prepare a column mapping for use in the datastore. This creates the column in the table.

Overrides:

prepareColumnMapping in class SingleFieldMapping

getObject

public Object getObject(org.datanucleus.ExecutionContext ec,
                        ResultSet resultSet,
                        int[] exprIndex)

Description copied from class: JavaTypeMapping

Obtains a value from datastoreResults at position specified by exprIndex.

Overrides:

getObject in class SingleFieldMapping

Parameters:

ec - ExecutionContext

resultSet - ResultSet

exprIndex - the position of the value in the result

Returns:

the value