Package org.sqlproc.engine

Interface SqlEngineFactory

All Known Implementing Classes:
JdbcEngineFactory, SqlDefaultFactory
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 Details

    • 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 instantiates 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 instantiates 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 instantiates 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 instantiates 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 instantiates 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 instantiates 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

    • isLazyInit

      boolean isLazyInit()
      Returns the indicator to speed up the initialization process
      Returns:
      the indicator to speed up the initialization process

    • getAsyncInitThreads

      @Beta int getAsyncInitThreads()
      Returns the number of threads used for asynchronous initialization
      Returns:
      the number of threads used for asynchronous initialization

    • isAsyncInitFinished

      @Beta Boolean isAsyncInitFinished()
      Returns the flag indicating the asynchronous SQL Processor engines initialization has been finished.
      Returns:
      the flag indicating the asynchronous SQL Processor engines initialization has been finished

    • getQueryNames

      Collection<String> getQueryNames()
      Returns the collection of names of all initialized/constructed static SQL Query Engine instances.
      Returns:
      The collection of all initialized static SQL Query Engine instances' names

    • getQueryDynamicNames

      Collection<String> getQueryDynamicNames()
      Returns the collection of names of all initialized/constructed dynamic SQL Query Engine instances.
      Returns:
      The collection of all initialized dynamic SQL Query Engine instances' names

    • getQueryEngines

      Map<String,SqlEngine> getQueryEngines()
      Returns the collection of named dynamic SQL Query Engines (the primary SQL Processor class) instances.
      Returns:
      The collection of named dynamic SQL Query Engines (the primary SQL Processor class) instances

    • getQueryDynamicEngines

      Map<String,SqlEngine> getQueryDynamicEngines()
      Returns the collection of names of all initialized/constructed dynamic SQL Query Engine instances.
      Returns:
      The collection of all initialized dynamic SQL Query Engine instances' names

    • getCrudNames

      Collection<String> getCrudNames()
      Returns the collection of names of all initialized/constructed static SQL CRUD Engine instances.
      Returns:
      The collection of all initialized static SQL CRUD Engine instances' names

    • getCrudDynamicNames

      Collection<String> getCrudDynamicNames()
      Returns the collection of names of all initialized/constructed dynamic SQL CRUD Engine instances.
      Returns:
      The collection of all initialized dynamic SQL CRUD Engine instances' names

    • getCrudEngines

      Map<String,SqlEngine> getCrudEngines()
      Returns the collection of named dynamic SQL CRUD Engines (the primary SQL Processor class) instances.
      Returns:
      The collection of named dynamic SQL CRUD Engines (the primary SQL Processor class) instances

    • getCrudDynamicEngines

      Map<String,SqlEngine> getCrudDynamicEngines()
      Returns the collection of names of all initialized/constructed dynamic SQL CRUD Engine instances.
      Returns:
      The collection of all initialized dynamic SQL CRUD Engine instances' names

    • getProcedureNames

      Collection<String> getProcedureNames()
      Returns the collection of names of all initialized/constructed static SQL Procedure Engine instances.
      Returns:
      The collection of all initialized static SQL Procedure Engine instances' names

    • getProcedureDynamicNames

      Collection<String> getProcedureDynamicNames()
      Returns the collection of names of all initialized/constructed dynamic SQL Procedure Engine instances.
      Returns:
      The collection of all initialized dynamic SQL Procedure Engine instances' names

    • getProcedureEngines

      Map<String,SqlEngine> getProcedureEngines()
      Returns the collection of named dynamic SQL Procedure Engines (the primary SQL Processor class) instances.
      Returns:
      The collection of named dynamic SQL Procedure Engines (the primary SQL Processor class) instances

    • getProcedureDynamicEngines

      Map<String,SqlEngine> getProcedureDynamicEngines()
      Returns the collection of names of all initialized/constructed dynamic SQL Procedure Engine instances.
      Returns:
      The collection of all initialized dynamic SQL Procedure Engine instances' names

    • getConfiguration

      SqlEngineConfiguration getConfiguration()
      Returns the overall dynamic configuration
      Returns:
      the overall dynamic configuration

    • getEnginesInitErrors

      Map<String,String> getEnginesInitErrors()
      Returns the result of engines initialization process. For every engine, for which there's error in the initialization process there a error message. In the case there's no error, the result message is null.
      Returns:
      the result of engines initialization process

    • getEnginesInitErrorsMsg

      String getEnginesInitErrorsMsg()
      Returns the result of engines initialization process. For every engine, for which there's error in the initialization process there a error message. In the case there's no error, the result message is null.
      Returns:
      the result of engines initialization process