SqlEngine (SQL Processor 1.0.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.sqlproc.engine
Class SqlEngine

java.lang.Object
  org.sqlproc.engine.SqlEngine

public class SqlEngine
extends java.lang.Object
extends java.lang.Object

The primary SQL Processor class for the META SQL query execution.

Instance of this class holds one META SQL and one Mapping rule.

For example there's a table PERSON with two columns - ID and NAME.
In queries.properties there's the next definition:

 LIST_ALL_SQL= \
   select p.ID id, p.NAME name \
   from PERSON p \
   where 1=1 \
   {& id=:id} \
   {& UPPER(name)=:+name} \
   {#1 order by ID} \
   {#2 order by NAME}
 LIST_ALL_FIELDS=id name

In the case of SQL Processor initialization

 SqlPropertiesLoader loader = new SqlPropertiesLoader("queries.properties", this.getClass());
 SqlEngineLoader sqlLoader = new SqlEngineLoader(loader.getProperties());
 SqlEngine sqlEngine = sqlLoader.getSqlEngine("ALL");

there's created an instance of SqlEngine with the name ALL.

Next the query can be executed with one of the queryXXX methods. For example there's a Java bean class Person with attributes id and name. The invocation

 List<Person> list = sqlEngine.query(session, Person.class, null, SqlEngine.ASC_ORDER);

produces the next SQL execution

 select p.ID id, p.NAME name from PERSON p order by ID ASC

Next there's an instance person of the class Person with the value Jan for the attribute name. The invocation

 List<Person> list = sqlEngine.query(session, Person.class, person, SqlOrder.getDescOrder(2));

produces the next SQL execution

 select p.ID id, p.NAME name from PERSON p where 1=1  AND  UPPER(name)=?  order by NAME DESC

For more info please see the User's tutorial.

Author:: Vladimir Hudec

Field Summary
`static SqlOrder`	`ASC_ORDER` The ordering directive list with one asscending ordering rule.
`static SqlOrder`	`DESC_ORDER` the ordering directive list with one descending ordering rule.
`private java.util.Map<java.lang.String,java.lang.Object>`	`features` Configuration of SQL Processor using Map of features.
`protected org.slf4j.Logger`	`logger` The internal slf4j logger.
`private SqlMappingRule`	`mapping` Precompiled Mapping rule, which is SQL result to Java output classes mapping prescription.
`private SqlMonitor`	`monitor` Monitor for the runtime statistics gathering.
`private java.lang.String`	`name` Name of this META SQL, which uniquely identifies the instance.
`static SqlOrder`	`NO_ORDER` The ordering directive list with no ordering rule.
`private SqlMetaStatement`	`statement` Precompiled META SQL, which is ANSI SQL extension using ANTLR defined grammar.

Constructor Summary
`SqlEngine(java.lang.String name, SqlMetaStatement statement, SqlMappingRule mapping)` Creates a new instance of SqlEngine from one META SQL statement and one SQL Mapping rule instance.
`SqlEngine(java.lang.String name, SqlMetaStatement statement, SqlMappingRule mapping, SqlMonitor monitor, java.util.Map<java.lang.String,java.lang.Object> features)` Creates a new instance of SqlEngine from one META SQL statement and one SQL Mapping rule instance.
`SqlEngine(java.lang.String name, java.lang.String statement, java.lang.String mapping)` Creates a new instance of SqlEngine from one META SQL statement string and one SQL Mapping rule string.
`SqlEngine(java.lang.String name, java.lang.String statement, java.lang.String mapping, SqlMonitor monitor, java.util.Map<java.lang.String,java.lang.Object> features)` Creates a new instance of SqlEngine from one META SQL statement string and one SQL Mapping rule string.

Method Summary

private java.lang.String countSql(SqlProcessResult processResult)

SqlMonitor getMonitor()
Returns the SQL Monitor instance for the runtime statistics gathering.

java.lang.String getName()
Returns the name of this META SQL, which uniquely identifies the instance.

java.lang.String getSql(java.lang.Object dynamicInputValues, java.lang.Object staticInputValues, SqlOrder order)
Because SQL Processor is Data Driven Query engine, every input parameters can produce in fact different SQL query command.





<E> java.util.List<E>

query(org.hibernate.Session session,
      java.lang.Class<E> resultClass)