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:

 <beans ...>
   ...
   <bean id="typeFactory" class="org.sqlproc.engine.jdbc.type.JdbcTypeFactory" factory-method="getInstance" />
 
   <bean id="sqlQueries" class="org.springframework.beans.factory.config.PropertiesFactoryBean">
     <property name="location">
       <value>classpath:queries.properties</value>
     </property>
   </bean>
   
   <bean id="sqlFactory" class="org.sqlproc.engine.SqlSimpleFactory" init-method="init">
     <property name="metaProps" ref="sqlQueries" />
     <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 Reference Guide or the tutorials.

Author:

Vladimir Hudec

Field Summary

private List<SqlInternalType>	customTypes The custom META types.
protected static String	DEFAULT_META_PROPS_NAME Default value for metaPropsName.
private String	filter The properties name prefix to filter the META SQL statements, mapping rules and optional features.
private boolean	jdbc The indicator the JDBC stack is used.
private SqlEngineLoader	loader The helper class for the META SQL statements and mapping rules parsing.
private Properties	metaProps The collection of META SQL statements, mapping rules and optional features.
private String	metaPropsName The name of file, which holds a collection of 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[]	selectQueries Only statements and rules with the names in this set are picked up from the properties repository.
private SqlTypeFactory	typeFactory The factory for the META types construction.

Constructor Summary

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

Method Summary

void	addCustomType(SqlInternalType customType) Adds a new custom META types.
SqlCrudEngine	getCrudEngine(String name) Returns the named SQL CRUD Engine instance (the primary SQL Processor class).
List<SqlInternalType>	getCustomTypes() Returns the custom META types.
String	getFilter() Returns the properties name prefix to filter the META SQL statements, mapping rules and optional features.
SqlEngineLoader	getLoader() Returns the internal SQL Engine loader.
Properties	getMetaProps() Returns the collection of META SQL statements, mapping rules and optional features.
String	getMetaPropsName() Returns the name of file, which holds a collection of META SQL statements, mapping rules and optional features.
SqlMonitorFactory	getMonitorFactory() Returns the monitor factory used in the process of the SQL Monitor instances creation.
SqlQueryEngine	getQueryEngine(String name) Returns the named SQL Query Engine instance (the primary SQL Processor class).
String[]	getSelectQueries() Returns the only statements and rules, which are picked up from the properties repository.
SqlTypeFactory	getTypeFactory() Returns the factory for the META types construction.
void	init() Dynamic init, called mainly from the Spring configuration initialization.
boolean	isJdbc() Return the indicator the JDBC stack is used.
void	setCustomTypes(List<SqlInternalType> customTypes) Sets the custom META types.
void	setFilter(String filter) Sets the properties name prefix to filter the META SQL statements, mapping rules and optional features.
void	setJdbc(boolean jdbc) Sets the indicator the JDBC stack is used.
void	setMetaProps(Properties props) Sets the collection of META SQL statements, mapping rules and optional features.
void	setMetaPropsName(String propsName) Sets the name of file, which holds a collection of 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	setSelectQueries(String[] selectQueries) Sets the only statements and rules, which are picked up from the properties repository.
void	setTypeFactory(SqlTypeFactory typeFactory) Sets the factory for the META types construction.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_META_PROPS_NAME

protected static final String DEFAULT_META_PROPS_NAME

Default value for metaPropsName.

See Also:

Constant Field Values

metaPropsName

private String metaPropsName

The name of file, which holds a collection of META SQL statements, mapping rules and optional features.

metaProps

private Properties metaProps

The collection of META SQL statements, mapping rules and optional features.

typeFactory

private SqlTypeFactory typeFactory

The factory for the META types construction.

filter

private String filter

The properties name prefix 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.

selectQueries

private String[] selectQueries

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.

loader

private SqlEngineLoader loader

The helper class for the META SQL statements and mapping rules parsing.

Constructor Detail

SqlSimpleFactory

public SqlSimpleFactory()

Creates a new instance with no default values.

Method Detail

init

public void init()

Dynamic init, called mainly from the Spring configuration initialization.

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

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

getMetaPropsName

public String getMetaPropsName()

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

Returns:

the name of file, which holds a collection of META SQL statements, mapping rules and optional features

setMetaPropsName

public void setMetaPropsName(String propsName)

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

Parameters:

propsName - the name of file, which holds a collection of META SQL statements, mapping rules and optional features

getMetaProps

public Properties getMetaProps()

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

Returns:

the collection of META SQL statements, mapping rules and optional features

setMetaProps

public void setMetaProps(Properties props)

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

Parameters:

props - the collection of 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

getFilter

public String getFilter()

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

Returns:

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

setFilter

public void setFilter(String filter)

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

Parameters:

filter - the properties name prefix 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

addCustomType

public void addCustomType(SqlInternalType customType)

Adds a new custom META types.

Parameters:

customType - the custom META type

getSelectQueries

public String[] getSelectQueries()

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

setSelectQueries

public void setSelectQueries(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

getLoader

public SqlEngineLoader getLoader()

Returns the internal SQL Engine loader.

Returns:

the internal SQL Engine loader