org.ametys.core.datasource.dbtype

Class SQLDatabaseTypeExtensionPoint

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.runtime.plugin.component.AbstractThreadSafeComponentExtensionPoint<SQLDatabaseType>

org.ametys.core.datasource.dbtype.SQLDatabaseTypeExtensionPoint

All Implemented Interfaces:

LogEnabled, ExtensionPoint<SQLDatabaseType>, Disposable, Initializable, Component, Contextualizable, Serviceable, ThreadSafe

public class SQLDatabaseTypeExtensionPoint
extends AbstractThreadSafeComponentExtensionPoint<SQLDatabaseType>

This class is in charge to load and initialize the SQLDatabaseType

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROLE Avalon Role

Fields inherited from class org.ametys.runtime.plugin.component.AbstractThreadSafeComponentExtensionPoint

_cocoonManager, _context, _manager

Constructor Summary

Constructors

Constructor and Description
SQLDatabaseTypeExtensionPoint()

Method Summary

Modifier and Type	Method and Description
Map<Object,I18nizableText>	getSQLDatabaseTypes() Get the SQL database types with their label
void	initializeExtensions() Finalize the initialization of the extensions. This method is called after all addExtension() calls. This is the last step before the actual startup of the application.
String	languageEscapeTableName(String dbtype, String tableNameToEscape) Some db systems requires the table names to be escaped
String	languageLimitQuery(String dbtype, String queryToLimit, String limit, String offset) Add a limit/offset element to the given query

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

addComponent, addExtension, contextualize, dispose, getExtension, getExtensionsIds, hasExtension, initialize, service

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 Detail

ROLE

public static final String ROLE

Avalon Role

Constructor Detail

SQLDatabaseTypeExtensionPoint

public SQLDatabaseTypeExtensionPoint()

Method Detail

initializeExtensions

public void initializeExtensions()
                          throws Exception

Description copied from interface: ExtensionPoint

Finalize the initialization of the extensions.
This method is called after all addExtension() calls.
This is the last step before the actual startup of the application.

Specified by:

initializeExtensions in interface ExtensionPoint<SQLDatabaseType>

Overrides:

initializeExtensions in class AbstractThreadSafeComponentExtensionPoint<SQLDatabaseType>

Throws:

Exception - if something wrong occurs

getSQLDatabaseTypes

public Map<Object,I18nizableText> getSQLDatabaseTypes()

Get the SQL database types with their label

Returns:

the SQL database types with their label

languageEscapeTableName

public String languageEscapeTableName(String dbtype,
                                      String tableNameToEscape)

Some db systems requires the table names to be escaped

Parameters:

dbtype - The identifier of the db type used

tableNameToEscape - The non-null table name

Returns:

The escaped table name or at least the table name if no escape is required. Or null if the dbtype is unknown.

languageLimitQuery

public String languageLimitQuery(String dbtype,
                                 String queryToLimit,
                                 String limit,
                                 String offset)

Add a limit/offset element to the given query

Parameters:

dbtype - The identifier of the db type used

queryToLimit - The sql query that will be amended

limit - The max number of the results to return

offset - The initial offset of the results to return

Returns:

The initial query amended to handle the limit and offset. Or null if the dbtype is unknown.