Package org.ametys.plugins.odfsync.apogee

Class AbstractApogeeDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.datasource.AbstractMyBatisDAO

org.ametys.plugins.odfsync.apogee.AbstractApogeeDAO

All Implemented Interfaces:

LogEnabled, PluginAware, Component, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

ApogeeDAO, ApogeePreviousYearsFieldsDAO

public abstract class AbstractApogeeDAO
extends AbstractMyBatisDAO

Data access object to the remote DB Apogee

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	DATASOURCE_REQUEST_ATTR	The name of request attribute for the datasource id

Fields inherited from class org.ametys.core.datasource.AbstractMyBatisDAO

_manager

Constructor Summary

Constructors

Constructor	Description
AbstractApogeeDAO()

Method Summary

Modifier and Type	Method	Description
protected void	_configureDatasource(Configuration configuration)	Configure datasource
protected List<Map<String,Object>>	_executeSearch(String dataSourceId, Map<String,Object> sccParams, Map<String,Object> params, String query)	Returns the Apogee objects matching the search criteria on the asked statement.
protected String	_getDataSourceId()	Get datasource id
protected Configuration	_getMyBatisConfiguration(Environment env)	Get the mybatis configuration
protected Request	_getRequest()	Get the request
protected void	_prepareSqlRequest(String dataSourceId, Map<String,Object> sccParams, Map<String,Object> params)	Common method to prepare the SQL request to execute
void	contextualize(Context context)

Methods inherited from class org.ametys.core.datasource.AbstractMyBatisDAO

configure, getSession, getSession, reload, service, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

DATASOURCE_REQUEST_ATTR

protected static final String DATASOURCE_REQUEST_ATTR

The name of request attribute for the datasource id

Constructor Details

AbstractApogeeDAO

public AbstractApogeeDAO()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Overrides:

contextualize in class AbstractMyBatisDAO

Throws:

ContextException

_getMyBatisConfiguration

protected Configuration _getMyBatisConfiguration(Environment env)

Description copied from class: AbstractMyBatisDAO

Get the mybatis configuration

Overrides:

_getMyBatisConfiguration in class AbstractMyBatisDAO

Parameters:

env - the mybatis environnement

Returns:

the mybatis configuration

_configureDatasource

protected void _configureDatasource(Configuration configuration)
                             throws ConfigurationException

Description copied from class: AbstractMyBatisDAO

Configure datasource

Overrides:

_configureDatasource in class AbstractMyBatisDAO

Parameters:

configuration - the configuration

Throws:

ConfigurationException - if an error occurred

_getDataSourceId

protected String _getDataSourceId()

Description copied from class: AbstractMyBatisDAO

Get datasource id

Overrides:

_getDataSourceId in class AbstractMyBatisDAO

Returns:

the datasource id

_getRequest

protected Request _getRequest()

Get the request

Returns:

the request

_executeSearch

protected List<Map<String,Object>> _executeSearch(String dataSourceId,
 Map<String,Object> sccParams,
 Map<String,Object> params,
 String query)

Returns the Apogee objects matching the search criteria on the asked statement.

Parameters:

dataSourceId - The id of data source. Can not be null.

sccParams - the parameters values of the Apogee synchronizable collection

params - The parameters for search criteria

query - The query identifier to execute

Returns:

the list Apogee objects matching the search criteria

_prepareSqlRequest

protected void _prepareSqlRequest(String dataSourceId,
 Map<String,Object> sccParams,
 Map<String,Object> params)

Common method to prepare the SQL request to execute

Parameters:

dataSourceId - The id of data source. Can not be null.

sccParams - the parameters values of the used Apogee synchronizable collection

params - the SQL parameters