org.sqlproc.engine
Interface SqlEngineFactory

All Known Implementing Classes:

JdbcEngineFactory, SqlProcessorLoader, SqlSimpleFactory

public interface SqlEngineFactory

The factory definition, which can be used to construct the SqlEngine instances.

The factory can be based on Spring DI framework for example.

For more info please see the Tutorials.

Author:

Vladimir Hudec

Method Summary

SqlCrudEngine	getCheckedCrudEngine(String name) Returns the named static or dynamic SQL CRUD Engine instance (the primary SQL Processor class).
SqlProcedureEngine	getCheckedProcedureEngine(String name) Returns the named static or dynamic SQL Procedure Engine instance (the primary SQL Processor class).
SqlQueryEngine	getCheckedQueryEngine(String name) Returns the named static or dynamic SQL Query Engine instance (the primary SQL Processor class).
SqlCrudEngine	getCheckedStaticCrudEngine(String name) Returns the named static SQL CRUD Engine instance (the primary SQL Processor class).
SqlProcedureEngine	getCheckedStaticProcedureEngine(String name) Returns the named static SQL Procedure Engine instance (the primary SQL Processor class).
SqlQueryEngine	getCheckedStaticQueryEngine(String name) Returns the named static SQL Query Engine instance (the primary SQL Processor class).
SqlCrudEngine	getCrudEngine(String name) Returns the named static or dynamic SQL CRUD Engine instance (the primary SQL Processor class).
SqlCrudEngine	getDynamicCrudEngine(String name, String sqlStatement) Returns the named dynamic SQL CRUD Engine instance (the primary SQL Processor class).
Map<String,SqlEngine>	getDynamicEngines() Returns the collection of names of all initialized/constructed dynamic SQL Engine instances.
Collection<String>	getDynamicNames() Returns the collection of names of all initialized/constructed dynamic SQL Engine instances.
SqlProcedureEngine	getDynamicProcedureEngine(String name, String sqlStatement) Returns the named dynamic SQL Procedure Engine instance (the primary SQL Processor class).
SqlQueryEngine	getDynamicQueryEngine(String name, String sqlStatement) Returns the named dynamic SQL Query Engine instance (the primary SQL Processor class).
Map<String,SqlEngine>	getEngines() Returns the collection of named dynamic SQL Engines (the primary SQL Processor class) instances.
Collection<String>	getNames() Returns the collection of names of all initialized/constructed static SQL Engine instances.
SqlProcedureEngine	getProcedureEngine(String name) Returns the named static or dynamic SQL Procedure Engine instance (the primary SQL Processor class).
SqlQueryEngine	getQueryEngine(String name) Returns the named static or dynamic SQL Query Engine instance (the primary SQL Processor class).
SqlCrudEngine	getStaticCrudEngine(String name) Returns the named static SQL CRUD Engine instance (the primary SQL Processor class).
SqlProcedureEngine	getStaticProcedureEngine(String name) Returns the named static SQL Procedure Engine instance (the primary SQL Processor class).
SqlQueryEngine	getStaticQueryEngine(String name) Returns the named static SQL Query Engine instance (the primary SQL Processor class).
boolean	isLazyInit() Returns the indicator to speed up the initialization process

Method Detail

getQueryEngine

SqlQueryEngine getQueryEngine(String name)

Returns the named static or dynamic SQL Query Engine instance (the primary SQL Processor class). In fact it returns the cached instance in the case it exists (it can be a static or dynamic one). Otherwise it instantiate a new static instance.

Parameters:

name - the name of the required SQL Query Engine instance

Returns:

the SQL Engine instance or null value in the case the related statement is missing

getCrudEngine

SqlCrudEngine getCrudEngine(String name)

Returns the named static or dynamic SQL CRUD Engine instance (the primary SQL Processor class). In fact it returns the cached instance in the case it exists (it can be a static or dynamic one). Otherwise it instantiate a new static instance.

Parameters:

name - the name of the required SQL CRUD Engine instance

Returns:

the SQL Engine instance or null value in the case the related statement is missing

getProcedureEngine

SqlProcedureEngine getProcedureEngine(String name)

Returns the named static or dynamic SQL Procedure Engine instance (the primary SQL Processor class). In fact it returns the cached instance in the case it exists (it can be a static or dynamic one). Otherwise it instantiate a new static instance.

Parameters:

name - the name of the required SQL Procedure Engine instance

Returns:

the SQL Engine instance or null value in the case the related statement is missing

getDynamicQueryEngine

SqlQueryEngine getDynamicQueryEngine(String name,
                                     String sqlStatement)
                                     throws SqlEngineException

Returns the named dynamic SQL Query Engine instance (the primary SQL Processor class).

Parameters:

name - the name of the required SQL Query Engine instance

sqlStatement - the new SQL statement, which is going to replace the original one

Returns:

the SQL Engine instance

Throws:

SqlEngineException - in the case the original statement is missing

getDynamicCrudEngine

SqlCrudEngine getDynamicCrudEngine(String name,
                                   String sqlStatement)

Returns the named dynamic SQL CRUD Engine instance (the primary SQL Processor class).

Parameters:

name - the name of the required SQL CRUD Engine instance

sqlStatement - the new SQL statement, which is going to replace the original one

Returns:

the SQL Engine instance

Throws:

SqlEngineException - in the case the original statement is missing

getDynamicProcedureEngine

SqlProcedureEngine getDynamicProcedureEngine(String name,
                                             String sqlStatement)

Returns the named dynamic SQL Procedure Engine instance (the primary SQL Processor class).

Parameters:

name - the name of the required SQL Procedure Engine instance

sqlStatement - the new SQL statement, which is going to replace the original one

Returns:

the SQL Engine instance

Throws:

SqlEngineException - in the case the original statement is missing

getStaticQueryEngine

SqlQueryEngine getStaticQueryEngine(String name)

Returns the named static SQL Query Engine instance (the primary SQL Processor class).

Parameters:

name - the name of the required SQL Query Engine instance

Returns:

the SQL Engine instance or null value in the case the related statement is missing

getStaticCrudEngine

SqlCrudEngine getStaticCrudEngine(String name)

Returns the named static SQL CRUD Engine instance (the primary SQL Processor class).

Parameters:

name - the name of the required SQL CRUD Engine instance

Returns:

the SQL Engine instance or null value in the case the related statement is missing

getStaticProcedureEngine

SqlProcedureEngine getStaticProcedureEngine(String name)

Returns the named static SQL Procedure Engine instance (the primary SQL Processor class).

Parameters:

name - the name of the required SQL Procedure Engine instance

Returns:

the SQL Engine instance or null value in the case the related statement is missing

getCheckedQueryEngine

SqlQueryEngine getCheckedQueryEngine(String name)
                                     throws SqlEngineException

Returns the named static or dynamic SQL Query Engine instance (the primary SQL Processor class). In fact it returns the cached instance in the case it exists (it can be a static or dynamic one). Otherwise it instantiate a new static instance.

Parameters:

name - the name of the required SQL Query Engine instance

Returns:

the SQL Engine instance

Throws:

SqlEngineException - in the case the related statement is missing

getCheckedCrudEngine

SqlCrudEngine getCheckedCrudEngine(String name)

Returns the named static or dynamic SQL CRUD Engine instance (the primary SQL Processor class). In fact it returns the cached instance in the case it exists (it can be a static or dynamic one). Otherwise it instantiate a new static instance.

Parameters:

name - the name of the required SQL CRUD Engine instance

Returns:

the SQL Engine instance

Throws:

SqlEngineException - in the case the related statement is missing

getCheckedProcedureEngine

SqlProcedureEngine getCheckedProcedureEngine(String name)

Returns the named static or dynamic SQL Procedure Engine instance (the primary SQL Processor class). In fact it returns the cached instance in the case it exists (it can be a static or dynamic one). Otherwise it instantiate a new static instance.

Parameters:

name - the name of the required SQL Procedure Engine instance

Returns:

the SQL Engine instance

Throws:

SqlEngineException - in the case the related statement is missing

getCheckedStaticQueryEngine

SqlQueryEngine getCheckedStaticQueryEngine(String name)
                                           throws SqlEngineException

Returns the named static SQL Query Engine instance (the primary SQL Processor class).

Parameters:

name - the name of the required SQL Query Engine instance

Returns:

the SQL Engine instance

Throws:

SqlEngineException - in the case the related statement is missing

getCheckedStaticCrudEngine

SqlCrudEngine getCheckedStaticCrudEngine(String name)

Returns the named static SQL CRUD Engine instance (the primary SQL Processor class).

Parameters:

name - the name of the required SQL CRUD Engine instance

Returns:

the SQL Engine instance

Throws:

SqlEngineException - in the case the related statement is missing

getCheckedStaticProcedureEngine

SqlProcedureEngine getCheckedStaticProcedureEngine(String name)

Returns the named static SQL Procedure Engine instance (the primary SQL Processor class).

Parameters:

name - the name of the required SQL Procedure Engine instance

Returns:

the SQL Engine instance

Throws:

SqlEngineException - in the case the related statement is missing

getNames

Collection<String> getNames()

Returns the collection of names of all initialized/constructed static SQL Engine instances.

Returns:

The collection of all initialized static SQL Engine instances' names

getDynamicNames

Collection<String> getDynamicNames()

Returns the collection of names of all initialized/constructed dynamic SQL Engine instances.

Returns:

The collection of all initialized dynamic SQL Engine instances' names

getEngines

Map<String,SqlEngine> getEngines()

Returns the collection of named dynamic SQL Engines (the primary SQL Processor class) instances.

Returns:

The collection of named dynamic SQL Engines (the primary SQL Processor class) instances

getDynamicEngines

Map<String,SqlEngine> getDynamicEngines()

Returns the collection of names of all initialized/constructed dynamic SQL Engine instances.

Returns:

The collection of all initialized dynamic SQL Engine instances' names

isLazyInit

boolean isLazyInit()

Returns the indicator to speed up the initialization process

Returns:

the indicator to speed up the initialization process