org.sqlproc.engine
Class SqlSimpleFactory

java.lang.Object
  org.sqlproc.engine.SqlSimpleFactory

All Implemented Interfaces:

SqlEngineFactory

Direct Known Subclasses:

JdbcEngineFactory

public class SqlSimpleFactory
extends Object
implements SqlEngineFactory

The simple implementation of the SqlEngineFactory.

It's suitable mainly for the Spring DI based configuration, like the next one for the loader SqlProcessorLoader:

 <beans ...>
   ...
   <bean id="typeFactory" class="org.sqlproc.engine.jdbc.type.JdbcTypeFactory" factory-method="getInstance" />
 
   <bean id="sqlFactory" class="org.sqlproc.engine.SqlSimpleFactory" init-method="init">
     <property name="metaFilesNames">
       <list>
         <value>statements.qry</value>
       </list>
     </property>
     <property name="typeFactory" ref="typeFactory" />
   </bean>
 </beans>
 

and use the next code to obtain an instance of the SQL Query engine

 SqlQueryEngine sqlEngine = sqlFactory.getQueryEngine("ALL");
 

or the next code to obtain an instance of the SQL CRUD engine

 SqlCrudEngine sqlEngine = sqlFactory.getCrudEngine("ALL");
 

In the case the SQL Processor runs on the top of the JDBC stack, there's more suitable JdbcEngineFactory.

For more info please see the Tutorials.

Author:

Vladimir Hudec

Field Summary

private List<SqlInternalType>	customTypes The custom META types.
private String	filter The name of the filter to filter the META SQL statements, mapping rules and optional features.
private boolean	jdbc The indicator the JDBC stack is used.
private boolean	lazyInit This flag indicates to speed up the initialization process.
private static String	LINESEP The platform based line separator.
private List<String>	metaFilesNames The names of files, which hold a collection of the SQL Processor artifacts (META SQL statements, mapping rules and optional features).
private StringBuilder	metaStatements The String representation of all SQL Processor artifacts (META SQL statements, mapping rules and optional features).
private SqlMonitorFactory	monitorFactory The monitor factory used in the process of the SQL Monitor instances creation.
private String[]	onlyStatements Only statements and rules with the names in this set are picked up from the properties repository.
protected SqlPluginFactory	pluginFactory The factory for the SQL Processor plugins.
private SqlProcessorLoader	processorLoader The helper class for the META SQL statements and mapping rules parsing.
private SqlTypeFactory	typeFactory The factory for the META types construction.
private SqlValidatorFactory	validatorFactory The validator factory used in the process of the SQL Monitor instances creation.

Constructor Summary

SqlSimpleFactory()
Creates a new instance with no default values.

SqlSimpleFactory(boolean lazyInit)
Creates a new instance with no default values.

Method Summary

void	addCustomType(SqlInternalType customType) Adds a new custom META type.
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).
List<SqlInternalType>	getCustomTypes() Returns the custom META types.
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.
String	getFilter() Returns the name of the filter to filter the META SQL statements, mapping rules and optional features.
SqlEngineFactory	getLoader() Returns the internal SQL engine or processor loader.
List<String>	getMetaFilesNames() Returns the names of files, which holds a collection of META SQL statements, mapping rules and optional features.
StringBuilder	getMetaStatements() Returns the String representation of the META SQL statements, mapping rules and optional features.
SqlMonitorFactory	getMonitorFactory() Returns the monitor factory used in the process of the SQL Monitor instances creation.
Collection<String>	getNames() Returns the collection of names of all initialized/constructed static SQL Engine instances.
String[]	getOnlyStatements() Returns the only statements and rules, which are picked up from the properties repository.
SqlPluginFactory	getPluginFactory() Returns the factory for the SQL Processor plugins.
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).
SqlTypeFactory	getTypeFactory() Returns the factory for the META types construction.
SqlValidatorFactory	getValidatorFactory() Returns the validator factory used in the process of the SQL Monitor instances creation.
void	init() Dynamic initialization, called mainly from the Spring configuration initialization.
void	init0() Conditional dynamic initialization, called mainly from the Spring configuration initialization.
boolean	isJdbc() Return the indicator the JDBC stack is used.
boolean	isLazyInit() Returns the indicator to speed up the initialization process
void	setCustomTypes(List<SqlInternalType> customTypes) Sets the custom META types.
void	setCustomTypes(SqlInternalType... customTypes) Sets the custom META types.
void	setFilter(String filter) Sets the name of the filter to filter the META SQL statements, mapping rules and optional features.
void	setJdbc(boolean jdbc) Sets the indicator the JDBC stack is used.
void	setLazyInit(boolean lazyInit) Sets the indicator to speed up the initialization process
void	setMetaFilesNames(List<String> metaFilesNames) Sets the names of files, which holds a collection of META SQL statements, mapping rules and optional features.
void	setMetaFilesNames(String... metaFilesNames) Sets the names of files, which holds a collection of META SQL statements, mapping rules and optional features.
void	setMetaStatements(StringBuilder metaStatements) Sets the String representation of the META SQL statements, mapping rules and optional features.
void	setMonitorFactory(SqlMonitorFactory monitorFactory) Sets the monitor factory used in the process of the SQL Monitor instances creation.
void	setOnlyStatements(String[] selectQueries) Sets the only statements and rules, which are picked up from the properties repository.
void	setPluginFactory(SqlPluginFactory pluginFactory) Sets the factory for the SQL Processor plugins.
void	setTypeFactory(SqlTypeFactory typeFactory) Sets the factory for the META types construction.
void	setValidatorFactory(SqlValidatorFactory validatorFactory) Sets the validator factory used in the process of the SQL Monitor instances creation.

Methods inherited from class java.lang.Object

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

Field Detail

LINESEP

private static final String LINESEP

The platform based line separator.

metaFilesNames

private List<String> metaFilesNames

The names of files, which hold a collection of the SQL Processor artifacts (META SQL statements, mapping rules and optional features).

metaStatements

private StringBuilder metaStatements

The String representation of all SQL Processor artifacts (META SQL statements, mapping rules and optional features).

typeFactory

private SqlTypeFactory typeFactory

The factory for the META types construction.

pluginFactory

protected SqlPluginFactory pluginFactory

The factory for the SQL Processor plugins.

filter

private String filter

The name of the filter to filter the META SQL statements, mapping rules and optional features.

monitorFactory

private SqlMonitorFactory monitorFactory

The monitor factory used in the process of the SQL Monitor instances creation.

customTypes

private List<SqlInternalType> customTypes

The custom META types.

onlyStatements

private String[] onlyStatements

Only statements and rules with the names in this set are picked up from the properties repository.

jdbc

private boolean jdbc

The indicator the JDBC stack is used.

processorLoader

private SqlProcessorLoader processorLoader

The helper class for the META SQL statements and mapping rules parsing. All artifacts are loaded from new grammar based files.

validatorFactory

private SqlValidatorFactory validatorFactory

The validator factory used in the process of the SQL Monitor instances creation.

lazyInit

private boolean lazyInit

This flag indicates to speed up the initialization process.

Constructor Detail

SqlSimpleFactory

public SqlSimpleFactory()

Creates a new instance with no default values.

SqlSimpleFactory

public SqlSimpleFactory(boolean lazyInit)

Creates a new instance with no default values.

Parameters:

lazyInit - this flag indicates to speed up the initialization process.

Method Detail

init

public void init()

Dynamic initialization, called mainly from the Spring configuration initialization.

init0

public void init0()

Conditional dynamic initialization, called mainly from the Spring configuration initialization.

getQueryEngine

public 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.

Specified by:

getQueryEngine in interface SqlEngineFactory

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

public 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.

Specified by:

getCrudEngine in interface SqlEngineFactory

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

public 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.

Specified by:

getProcedureEngine in interface SqlEngineFactory

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

getStaticQueryEngine

public SqlQueryEngine getStaticQueryEngine(String name)

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

Specified by:

getStaticQueryEngine in interface SqlEngineFactory

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

public SqlCrudEngine getStaticCrudEngine(String name)

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

Specified by:

getStaticCrudEngine in interface SqlEngineFactory

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

public SqlProcedureEngine getStaticProcedureEngine(String name)

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

Specified by:

getStaticProcedureEngine in interface SqlEngineFactory

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

public 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.

Specified by:

getCheckedQueryEngine in interface SqlEngineFactory

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

public 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.

Specified by:

getCheckedCrudEngine in interface SqlEngineFactory

Parameters:

name - the name of the required SQL CRUD Engine instance

Returns:

the SQL Engine instance

getCheckedProcedureEngine

public 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.

Specified by:

getCheckedProcedureEngine in interface SqlEngineFactory

Parameters:

name - the name of the required SQL Procedure Engine instance

Returns:

the SQL Engine instance

getCheckedStaticQueryEngine

public SqlQueryEngine getCheckedStaticQueryEngine(String name)
                                           throws SqlEngineException

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

Specified by:

getCheckedStaticQueryEngine in interface SqlEngineFactory

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

public SqlCrudEngine getCheckedStaticCrudEngine(String name)

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

Specified by:

getCheckedStaticCrudEngine in interface SqlEngineFactory

Parameters:

name - the name of the required SQL CRUD Engine instance

Returns:

the SQL Engine instance

getCheckedStaticProcedureEngine

public SqlProcedureEngine getCheckedStaticProcedureEngine(String name)

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

Specified by:

getCheckedStaticProcedureEngine in interface SqlEngineFactory

Parameters:

name - the name of the required SQL Procedure Engine instance

Returns:

the SQL Engine instance

getDynamicQueryEngine

public SqlQueryEngine getDynamicQueryEngine(String name,
                                            String sqlStatement)
                                     throws SqlEngineException

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

Specified by:

getDynamicQueryEngine in interface SqlEngineFactory

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

public SqlCrudEngine getDynamicCrudEngine(String name,
                                          String sqlStatement)

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

Specified by:

getDynamicCrudEngine in interface SqlEngineFactory

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

getDynamicProcedureEngine

public SqlProcedureEngine getDynamicProcedureEngine(String name,
                                                    String sqlStatement)

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

Specified by:

getDynamicProcedureEngine in interface SqlEngineFactory

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

getMetaFilesNames

public List<String> getMetaFilesNames()

Returns the names of files, which holds a collection of META SQL statements, mapping rules and optional features.

Returns:

the names of files, which holds a collection of META SQL statements, mapping rules and optional features

setMetaFilesNames

public void setMetaFilesNames(List<String> metaFilesNames)

Sets the names of files, which holds a collection of META SQL statements, mapping rules and optional features.

Parameters:

metaFilesNames - the names of files, which holds a collection of META SQL statements, mapping rules and optional features

setMetaFilesNames

public void setMetaFilesNames(String... metaFilesNames)

Sets the names of files, which holds a collection of META SQL statements, mapping rules and optional features.

Parameters:

metaFilesNames - the names of files, which holds a collection of META SQL statements, mapping rules and optional features

getMetaStatements

public StringBuilder getMetaStatements()

Returns the String representation of the META SQL statements, mapping rules and optional features.

Returns:

the String representation of the META SQL statements, mapping rules and optional features

setMetaStatements

public void setMetaStatements(StringBuilder metaStatements)

Sets the String representation of the META SQL statements, mapping rules and optional features.

Parameters:

metaStatements - the String representation of the META SQL statements, mapping rules and optional features

getTypeFactory

public SqlTypeFactory getTypeFactory()

Returns the factory for the META types construction.

Returns:

the factory for the META types construction

setTypeFactory

public void setTypeFactory(SqlTypeFactory typeFactory)

Sets the factory for the META types construction.

Parameters:

typeFactory - the factory for the META types construction

getPluginFactory

public SqlPluginFactory getPluginFactory()

Returns the factory for the SQL Processor plugins.

Returns:

the factory for the SQL Processor plugins

setPluginFactory

public void setPluginFactory(SqlPluginFactory pluginFactory)

Sets the factory for the SQL Processor plugins.

Parameters:

pluginFactory - the factory for the SQL Processor plugins

getFilter

public String getFilter()

Returns the name of the filter to filter the META SQL statements, mapping rules and optional features.

Returns:

the name of the filter to filter the META SQL statements, mapping rules and optional features

setFilter

public void setFilter(String filter)

Sets the name of the filter to filter the META SQL statements, mapping rules and optional features.

Parameters:

filter - the name of the filter to filter the META SQL statements, mapping rules and optional features

getMonitorFactory

public SqlMonitorFactory getMonitorFactory()

Returns the monitor factory used in the process of the SQL Monitor instances creation.

Returns:

the monitor factory used in the process of the SQL Monitor instances creation

setMonitorFactory

public void setMonitorFactory(SqlMonitorFactory monitorFactory)

Sets the monitor factory used in the process of the SQL Monitor instances creation.

Parameters:

monitorFactory - the monitor factory used in the process of the SQL Monitor instances creation

getCustomTypes

public List<SqlInternalType> getCustomTypes()

Returns the custom META types.

Returns:

the custom META types

setCustomTypes

public void setCustomTypes(List<SqlInternalType> customTypes)

Sets the custom META types.

Parameters:

customTypes - the custom META types

setCustomTypes

public void setCustomTypes(SqlInternalType... customTypes)

Sets the custom META types.

Parameters:

customTypes - the custom META types

addCustomType

public void addCustomType(SqlInternalType customType)

Adds a new custom META type.

Parameters:

customType - the custom META type

getOnlyStatements

public String[] getOnlyStatements()

Returns the only statements and rules, which are picked up from the properties repository.

Returns:

the only statements and rules, which are picked up from the properties repository

setOnlyStatements

public void setOnlyStatements(String[] selectQueries)

Sets the only statements and rules, which are picked up from the properties repository.

Parameters:

selectQueries - the only statements and rules, which are picked up from the properties repository

isJdbc

public boolean isJdbc()

Return the indicator the JDBC stack is used.

Returns:

the indicator the JDBC stack is used

setJdbc

public void setJdbc(boolean jdbc)

Sets the indicator the JDBC stack is used.

Parameters:

jdbc - the indicator the JDBC stack is used

isLazyInit

public boolean isLazyInit()

Returns the indicator to speed up the initialization process

Specified by:

isLazyInit in interface SqlEngineFactory

Returns:

the indicator to speed up the initialization process

setLazyInit

public void setLazyInit(boolean lazyInit)

Sets the indicator to speed up the initialization process

Parameters:

lazyInit - the indicator to speed up the initialization process

getLoader

public SqlEngineFactory getLoader()

Returns the internal SQL engine or processor loader.

Returns:

the internal SQL engine or processor loader

getValidatorFactory

public SqlValidatorFactory getValidatorFactory()

Returns the validator factory used in the process of the SQL Monitor instances creation.

Returns:

the validator factory used in the process of the SQL Monitor instances creation

setValidatorFactory

public void setValidatorFactory(SqlValidatorFactory validatorFactory)

Sets the validator factory used in the process of the SQL Monitor instances creation.

Parameters:

validatorFactory - the validator factory used in the process of the SQL Monitor instances creation

getNames

public Collection<String> getNames()

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

Specified by:

getNames in interface SqlEngineFactory

Returns:

The collection of all initialized static SQL Engine instances' names

getDynamicNames

public Collection<String> getDynamicNames()

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

Specified by:

getDynamicNames in interface SqlEngineFactory

Returns:

The collection of all initialized dynamic SQL Engine instances' names

getEngines

public Map<String,SqlEngine> getEngines()

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

Specified by:

getEngines in interface SqlEngineFactory

Returns:

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

getDynamicEngines

public Map<String,SqlEngine> getDynamicEngines()

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

Specified by:

getDynamicEngines in interface SqlEngineFactory

Returns:

The collection of all initialized dynamic SQL Engine instances' names