QueryObjectFactory

This document is the API specification for the QueryObjectFactory, version 1.0.0.

See:
Description

Core

sf.qof	Provides classes, interfaces and annotations for creation and definition of query classes.
sf.qof.adapter	Provides adapter classes and interfaces.
sf.qof.customizer	Provides classes, interfaces for customizing the code generation.
sf.qof.dialect	Provides classes, interfaces for database specific SQL syntax.
sf.qof.exception	Provides exception classes.
sf.qof.session	Provides classes, interfaces for session and transaction handling.

Other Packages

sf.qof.codegen	Internal package. Provides code generation classes using cglib/asm
sf.qof.mapping	Internal package. Provides classes for mappers of parameters and results.
sf.qof.parser	Internal package. Provides classes for basic tokenization of SQL queries.
sf.qof.util	Internal package. Provides utility classes

This document is the API specification for the QueryObjectFactory, version 1.0.0.

QueryObjectFactory is a lightweight runtime JDBC code generator providing support for CRUD (create, retrieve, update and delete) operations and stored procedure calls. It is not an object/relational mapping tool.

Mapping information is defined using Java annotations: Query, Insert, Update, Delete and Call.

Supported mapping options

It provides built-in mappers for all Java primitive types and their boxed versions (int, Integer, etc.) as well as string and date types. Support for other types can be added at runtime through the use of adapters (DynamicMappingAdapter and GeneratorMappingAdapter)

It can map to Java objects (using getters and setters according to the Java Bean specification) and supports collections as inputs and outputs.

It uses cglib/asm to create JDBC wrapper byte-code on the fly.

The static factory QueryObjectFactory is used to create query object implementations.

Implementing Customizer allows to change certain parts of the code generation

 This software is distributed under the GNU LESSER GENERAL PUBLIC LICENSE Version 3

 NO WARRANTIES

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 THE POSSIBILITY OF SUCH DAMAGE.