org.sqlproc.engine

Class SqlProcessorLoader

java.lang.Object

org.sqlproc.engine.SqlProcessorLoader

All Implemented Interfaces:

SqlEngineFactory

public class SqlProcessorLoader
extends Object
implements SqlEngineFactory

The helper class for the META SQL statements and mapping rules parsing. These statements and rules are taken from the file repository based on the provided ANTLR grammar.
The purpose of this class is to load and analyze (=parse) the SQL Processor artifacts:

• the META SQL statements
• the mapping rules
• the optional features

This is rather a low level helper class. For more simple approach please see SqlSimpleFactory

All the statements with the name name(QRY) are parsed as the META SQL queries using the ANTLR based grammar.
All the statements with the name name(CRUD) are parsed as the META SQL CRUD statements using the ANTLR based grammar.
All the statements with the name name(CALL) are parsed as the META SQL CALL statements using the ANTLR based grammar. These are used to call the stored procedures.
All the statements with the name name(OUT) are parsed as the mapping rules using the ANTLR based grammar.
A pair of the META SQL statement and the (optional) mapping rule forms one named SQL Engine instance.
All the statements with the name name(OPT) are taken as the optional features used in the process of the SQL query/statement generation and execution.

In the process of ANTLR based parsing different kinds of incorrect stuff can cause the SqlEngineException to be raised.

In the process of the META SQL statements and mapping rules parsing the input/output values META types have to be established. For this purpose a factory class responsible for these META types construction has to be supplied.

To initialize the SqlProcessorLoader, Spring DI configuration can be utilized, like the next one:

 <beans ...>
   ...
     <bean id="sqlFactory" class="org.sqlproc.engine.jdbc.JdbcEngineFactory" init-method="init">
         <property name="metaFilesNames">
             <list>
                 <value>statements.qry</value>
             </list>
         </property>
     </bean>
 </beans>
 

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

 SqlEngineFactory sqlFactory = context.getBean("sqlFactory", SqlEngineFactory.class);
 SqlQueryEngine sqlEngine = sqlFactory.getQueryEngine("ALL");
 

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

 SqlEngineFactory sqlFactory = context.getBean("sqlFactory", SqlEngineFactory.class);
 SqlCrudEngine sqlEngine = sqlFactory.getCrudEngine("ALL");
 

Another possibility is to utilize SqlFilesLoader.

 SqlFilesLoader loader = new SqlFilesLoader("statements.qry", this.getClass());
 SqlProcessorLoader sqlLoader = new SqlProcessorLoader(loader.getStatements(), JdbcTypeFactory.getInstance());
 SqlQueryEngine sqlEngine = sqlLoader.getQueryEngine("ALL");
 

For more info please see the Tutorials.

Author:

Vladimir Hudec

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,SqlMetaStatement>	calls The collection of named META SQL CALLABLE statements.
private SqlTypeFactory	composedTypeFactory The combined factory for the META types construction.
private Map<String,SqlMetaStatement>	cruds The collection of named META SQL CRUD statements.
private Map<String,SqlEngine>	engines The collection of named SQL Engines (the primary SQL Processor class) instances.
private Map<String,Object>	features The collection of the SQL Processor optional features.
protected org.slf4j.Logger	logger The internal slf4j logger.
private Map<String,SqlMappingRule>	outs The collection of named explicitly defined mapping rules.
private SqlPluginFactory	pluginFactory The factory for the SQL Processor plugins.
private Map<String,SqlMetaStatement>	sqls The collection of named META SQL queries.
private Map<String,Map<String,Object>>	statementsFeatures The collection of the SQL Processor optional features in the statement context.
private Map<String,Set<String>>	statementsFeaturesUnset The collection of the SQL Processor optional features to be cleared in the statement context.

Constructor Summary

Constructors

Constructor and Description
SqlProcessorLoader(StringBuilder sbStatements, SqlTypeFactory typeFactory, SqlPluginFactory pluginFactory) Creates a new instance of the SqlProcessorLoader from the String content repository (which is in fact a collection of the META SQL statements, mapping rules and optional features.
SqlProcessorLoader(StringBuilder sbStatements, SqlTypeFactory typeFactory, SqlPluginFactory pluginFactory, String filter) Creates a new instance of the SqlProcessorLoader from the String content repository (which is in fact a collection of the META SQL statements, mapping rules and optional features.
SqlProcessorLoader(StringBuilder sbStatements, SqlTypeFactory typeFactory, SqlPluginFactory pluginFactory, String filter, SqlMonitorFactory monitorFactory) Creates a new instance of the SqlProcessorLoader from the String content repository (which is in fact a collection of the META SQL statements, mapping rules and optional features.
SqlProcessorLoader(StringBuilder sbStatements, SqlTypeFactory typeFactory, SqlPluginFactory pluginFactory, String filter, SqlMonitorFactory monitorFactory, List<SqlInternalType> customTypes, String... onlyStatements) Creates a new instance of the SqlProcessorLoader from the String content repository (which is in fact a collection of the META SQL statements, mapping rules and optional features.
SqlProcessorLoader(StringBuilder sbStatements, SqlTypeFactory typeFactory, SqlPluginFactory pluginFactory, String filter, SqlMonitorFactory monitorFactory, SqlValidatorFactory validatorFactory, List<SqlInternalType> customTypes, String... onlyStatements) Creates a new instance of the SqlProcessorLoader from the String content repository (which is in fact a collection of the META SQL statements, mapping rules and optional features.
SqlProcessorLoader(StringBuilder sbStatements, SqlTypeFactory typeFactory, SqlPluginFactory pluginFactory, String filter, SqlMonitorFactory monitorFactory, String... onlyStatements) Creates a new instance of the SqlProcessorLoader from the String content repository (which is in fact a collection of the META SQL statements, mapping rules and optional features.

Method Summary

Methods

Modifier and Type	Method and Description
SqlCrudEngine	getCheckedCrudEngine(String name) Returns the named SQL CRUD Engine instance (the primary SQL Processor class).
SqlProcedureEngine	getCheckedProcedureEngine(String name) Returns the named SQL Procedure Engine instance (the primary SQL Processor class).
SqlQueryEngine	getCheckedQueryEngine(String name) Returns the named SQL Query Engine instance (the primary SQL Processor class).
SqlCrudEngine	getCrudEngine(String name) Returns the named SQL CRUD Engine instance (the primary SQL Processor class).
Collection<String>	getNames() Returns the collection of names of all initialized/constructed SQL Engine instances.
SqlProcedureEngine	getProcedureEngine(String name) Returns the named SQL Procedure Engine instance (the primary SQL Processor class).
SqlQueryEngine	getQueryEngine(String name) Returns the named SQL Query Engine instance (the primary SQL Processor class).
private void	loadStatementFeatures(String name) Some filters can be the optional features in the statement context.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

The internal slf4j logger.

composedTypeFactory

private SqlTypeFactory composedTypeFactory

The combined factory for the META types construction.

pluginFactory

private SqlPluginFactory pluginFactory

The factory for the SQL Processor plugins. This is the basic facility to alter the SQL Processor processing.

engines

private Map<String,SqlEngine> engines

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

sqls

private Map<String,SqlMetaStatement> sqls

The collection of named META SQL queries.

cruds

private Map<String,SqlMetaStatement> cruds

The collection of named META SQL CRUD statements.

calls

private Map<String,SqlMetaStatement> calls

The collection of named META SQL CALLABLE statements.

outs

private Map<String,SqlMappingRule> outs

The collection of named explicitly defined mapping rules.

features

private Map<String,Object> features

The collection of the SQL Processor optional features.

statementsFeatures

private Map<String,Map<String,Object>> statementsFeatures

The collection of the SQL Processor optional features in the statement context.

statementsFeaturesUnset

private Map<String,Set<String>> statementsFeaturesUnset

The collection of the SQL Processor optional features to be cleared in the statement context.

Constructor Detail

SqlProcessorLoader

public SqlProcessorLoader(StringBuilder sbStatements,
                  SqlTypeFactory typeFactory,
                  SqlPluginFactory pluginFactory)
                   throws SqlEngineException

Creates a new instance of the SqlProcessorLoader from the String content repository (which is in fact a collection of the META SQL statements, mapping rules and optional features. During the instance construction all the statements are parsed and the collection of named SQL Engine instances is established. Later these instances are used for the SQL queries/statements execution. For the purpose of the META types construction (located inside the META SQL statements and mapping rules) a factory instance has to be supplied.

Parameters:

sbStatements - the String representation of the META SQL queries/statements/output mappings

typeFactory - the factory for the META types construction

pluginFactory - the factory for the SQL Processor plugins

Throws:

SqlEngineException - mainly in the case the provided statements or rules are not compliant with the ANTLR based grammar

SqlProcessorLoader

public SqlProcessorLoader(StringBuilder sbStatements,
                  SqlTypeFactory typeFactory,
                  SqlPluginFactory pluginFactory,
                  String filter)
                   throws SqlEngineException

Creates a new instance of the SqlProcessorLoader from the String content repository (which is in fact a collection of the META SQL statements, mapping rules and optional features. During the instance construction all the statements are parsed and the collection of named SQL Engine instances is established. Later these instances are used for the SQL queries/statements execution. For the purpose of the META types construction (located inside the META SQL statements and mapping rules) a factory instance has to be supplied.

Parameters:

sbStatements - the String representation of the META SQL queries/statements/output mappings

typeFactory - the factory for the META types construction

pluginFactory - the factory for the SQL Processor plugins

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

Throws:

SqlEngineException - mainly in the case the provided statements or rules are not compliant with the ANTLR based grammar

SqlProcessorLoader

public SqlProcessorLoader(StringBuilder sbStatements,
                  SqlTypeFactory typeFactory,
                  SqlPluginFactory pluginFactory,
                  String filter,
                  SqlMonitorFactory monitorFactory)
                   throws SqlEngineException

Creates a new instance of the SqlProcessorLoader from the String content repository (which is in fact a collection of the META SQL statements, mapping rules and optional features. During the instance construction all the statements are parsed and the collection of named SQL Engine instances is established. Later these instances are used for the SQL queries/statements execution. For the purpose of the META types construction (located inside the META SQL statements and mapping rules) a factory instance has to be supplied. Every instance of the SQL Engine is accompanied with the SQL Monitor for the runtime statistics gathering. For the creation of these monitors the SQL Monitor Factory can be used.

Parameters:

sbStatements - the String representation of the META SQL queries/statements/output mappings

typeFactory - the factory for the META types construction

pluginFactory - the factory for the SQL Processor plugins

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

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

Throws:

SqlEngineException - mainly in the case the provided statements or rules are not compliant with the ANTLR based grammar

SqlProcessorLoader

public SqlProcessorLoader(StringBuilder sbStatements,
                  SqlTypeFactory typeFactory,
                  SqlPluginFactory pluginFactory,
                  String filter,
                  SqlMonitorFactory monitorFactory,
                  String... onlyStatements)

Creates a new instance of the SqlProcessorLoader from the String content repository (which is in fact a collection of the META SQL statements, mapping rules and optional features. During the instance construction all the statements are parsed and the collection of named SQL Engine instances is established. Later these instances are used for the SQL queries/statements execution. For the purpose of the META types construction (located inside the META SQL statements and mapping rules) a factory instance has to be supplied. Every instance of the SQL Engine is accompanied with the SQL Monitor for the runtime statistics gathering. For the creation of these monitors the SQL Monitor Factory can be used.

Parameters:

sbStatements - the String representation of the META SQL queries/statements/output mappings

typeFactory - the factory for the META types construction

pluginFactory - the factory for the SQL Processor plugins

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

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

onlyStatements - only statements and rules with the names in this container are picked up from the properties repository

Throws:

SqlEngineException - mainly in the case the provided statements or rules are not compliant with the ANTLR based grammar

SqlProcessorLoader

public SqlProcessorLoader(StringBuilder sbStatements,
                  SqlTypeFactory typeFactory,
                  SqlPluginFactory pluginFactory,
                  String filter,
                  SqlMonitorFactory monitorFactory,
                  List<SqlInternalType> customTypes,
                  String... onlyStatements)
                   throws SqlEngineException

Creates a new instance of the SqlProcessorLoader from the String content repository (which is in fact a collection of the META SQL statements, mapping rules and optional features. During the instance construction all the statements are parsed and the collection of named SQL Engine instances is established. Later these instances are used for the SQL queries/statements execution. For the purpose of the META types construction (located inside the META SQL statements and mapping rules) a factory instance has to be supplied. Every instance of the SQL Engine is accompanied with the SQL Monitor for the runtime statistics gathering. For the creation of these monitors the SQL Monitor Factory can be used.

Parameters:

sbStatements - the String representation of the META SQL queries/statements/output mappings

typeFactory - the factory for the META types construction

pluginFactory - the factory for the SQL Processor plugins

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

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

customTypes - the custom META types

onlyStatements - only statements and rules with the names in this container are picked up from the properties repository

Throws:

SqlEngineException - mainly in the case the provided statements or rules are not compliant with the ANTLR based grammar

SqlProcessorLoader

public SqlProcessorLoader(StringBuilder sbStatements,
                  SqlTypeFactory typeFactory,
                  SqlPluginFactory pluginFactory,
                  String filter,
                  SqlMonitorFactory monitorFactory,
                  SqlValidatorFactory validatorFactory,
                  List<SqlInternalType> customTypes,
                  String... onlyStatements)
                   throws SqlEngineException

Creates a new instance of the SqlProcessorLoader from the String content repository (which is in fact a collection of the META SQL statements, mapping rules and optional features. During the instance construction all the statements are parsed and the collection of named SQL Engine instances is established. Later these instances are used for the SQL queries/statements execution. For the purpose of the META types construction (located inside the META SQL statements and mapping rules) a factory instance has to be supplied. Every instance of the SQL Engine is accompanied with the SQL Monitor for the runtime statistics gathering. For the creation of these monitors the SQL Monitor Factory can be used.

Parameters:

sbStatements - the String representation of the META SQL queries/statements/output mappings

typeFactory - the factory for the META types construction

pluginFactory - the factory for the SQL Processor plugins

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

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

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

customTypes - the custom META types

onlyStatements - only statements and rules with the names in this container are picked up from the properties repository

Throws:

SqlEngineException - mainly in the case the provided statements or rules are not compliant with the ANTLR based grammar

Method Detail

loadStatementFeatures

private void loadStatementFeatures(String name)

Some filters can be the optional features in the statement context.

Parameters:

name - the name of the META SQL statement

getNames

public Collection<String> getNames()

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

Returns:

The collection of all initialized SQL Engine instances' names

getQueryEngine

public SqlQueryEngine getQueryEngine(String name)

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

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 SQL CRUD Engine instance (the primary SQL Processor class).

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 SQL Procedure Engine instance (the primary SQL Processor class).

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

getCheckedQueryEngine

public SqlQueryEngine getCheckedQueryEngine(String name)
                                     throws SqlEngineException

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

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 SQL CRUD Engine instance (the primary SQL Processor class).

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 SQL Procedure Engine instance (the primary SQL Processor class).

Specified by:

getCheckedProcedureEngine in interface SqlEngineFactory

Parameters:

name - the name of the required SQL Procedure Engine instance

Returns:

the SQL Engine instance