Package com.ibatis.sqlmap.engine.exchange

Interface DataExchange

All Known Implementing Classes:

BaseDataExchange, ComplexDataExchange, DomDataExchange, JavaBeanDataExchange, ListDataExchange, MapDataExchange, PrimitiveDataExchange

public interface DataExchange

Interface for exchanging data between a parameter map/result map and the related objects.

Method Summary

Modifier and Type	Method	Description
CacheKey	getCacheKey(StatementScope statementScope, ParameterMap parameterMap, Object parameterObject)	Returns an object capable of being a unique cache key for a parameter object.
Object[]	getData(StatementScope statementScope, ParameterMap parameterMap, Object parameterObject)	Gets a data array from a parameter object.
void	initialize(Map properties)	Initializes the data exchange instance.
Object	setData(StatementScope statementScope, ParameterMap parameterMap, Object parameterObject, Object[] values)	Sets values from a data array into a parameter object.
Object	setData(StatementScope statementScope, ResultMap resultMap, Object resultObject, Object[] values)	Sets values from a data array into a result object.

Method Details

initialize

void initialize(Map properties)

Initializes the data exchange instance.

Parameters:

properties - the properties

getData

Object[] getData(StatementScope statementScope,
 ParameterMap parameterMap,
 Object parameterObject)

Gets a data array from a parameter object.

Parameters:

statementScope - - the scope of the request

parameterMap - - the parameter map

parameterObject - - the parameter object

Returns:

- the objects

setData

Object setData(StatementScope statementScope,
 ResultMap resultMap,
 Object resultObject,
 Object[] values)

Sets values from a data array into a result object.

Parameters:

statementScope - - the request scope

resultMap - - the result map

resultObject - - the result object

values - - the values to be mapped

Returns:

the resultObject

setData

Object setData(StatementScope statementScope,
 ParameterMap parameterMap,
 Object parameterObject,
 Object[] values)

Sets values from a data array into a parameter object.

Parameters:

statementScope - - the request scope

parameterMap - - the parameter map

parameterObject - - the parameter object

values - - the values to set

Returns:

parameterObject

getCacheKey

CacheKey getCacheKey(StatementScope statementScope,
 ParameterMap parameterMap,
 Object parameterObject)

Returns an object capable of being a unique cache key for a parameter object.

Parameters:

statementScope - - the request scope

parameterMap - - the parameter map

parameterObject - - the parameter object

Returns:

- a cache key