sk.vracon.sqlcomments.core

Class StatementContainer

java.lang.Object

sk.vracon.sqlcomments.core.StatementContainer

public class StatementContainer
extends Object

Statement container implements loading and caching of statements.

Statement container is not mandatory, but it has some useful features like loading, caching and takes care of compiling control scripts.

Statement files are loaded from classpath in order:

1. Database specific statement file (if #databaseProductName is null this step is skipped).
2. Generic statement file (without database product name).

If no statement file is found, IllegalArgumentException is thrown.

The default script engine for control scripts is used JavaScript. All scripts are compiled before first usage. It is possible to use custom script engine by using StatementContainer(String) constructor. In this case used engine must implement Compilable interface.

For performance reasons caching is enabled by default. To disable it call setEnableCache(boolean). Disabling cache is useful for development.

See Also:

StatementParser, setEnableCache(boolean)

Constructor Summary

Constructors

Constructor and Description
StatementContainer() Creates instance of statement container with default settings.
StatementContainer(Compilable scriptEngine) Creates instance of statement container with specified script engine.
StatementContainer(String scriptEngineName) Creates instance of statement container with specified script engine.

Method Summary

Methods

Modifier and Type	Method and Description
Statement	addStatement(Class<?> baseClass, String name) Loads statement and adds it to cache.
Statement	addStatement(String statementName, String statementText) Parses statement text and adds it to cache if cache is enabled.
protected String	constructFullName(Class<?> baseClass, String name) Constructs full statement name from base class and short name.
Statement	getStatement(Class<?> baseClass, String name) Gets statement from cache.
Statement	getStatement(ClassLoader classLoader, String fullName) Gets statement from cache.
void	setDialect(DatabaseDialect dialect) Sets database dialect.
void	setEnableCache(boolean enableCache) Enable statement caching.

Methods inherited from class java.lang.Object

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

Constructor Detail

StatementContainer

public StatementContainer()

Creates instance of statement container with default settings.

Using javascript as a default script engine.

StatementContainer

public StatementContainer(String scriptEngineName)

Creates instance of statement container with specified script engine.

Parameters:

scriptEngineName - script engine name

See Also:

ScriptEngineManager

StatementContainer

public StatementContainer(Compilable scriptEngine)

Creates instance of statement container with specified script engine.

Parameters:

scriptEngine - script engine

Method Detail

addStatement

public Statement addStatement(Class<?> baseClass,
                     String name)
                       throws StatementNotFoundException

Loads statement and adds it to cache.

Parameters:

baseClass - base class (mandatory)

name - statement name (mandatory)

Returns:

loaded statement

Throws:

StatementNotFoundException - if statement file not found

See Also:

StatementConfiguration

constructFullName

protected String constructFullName(Class<?> baseClass,
                       String name)

Constructs full statement name from base class and short name.

Parameters:

baseClass - base class

name - short name

Returns:

full statement name (file path)

addStatement

public Statement addStatement(String statementName,
                     String statementText)

Parses statement text and adds it to cache if cache is enabled.

Parameters:

statementName - statement name under which it should be cached

statementText - statement body

Returns:

parsed statement

getStatement

public Statement getStatement(Class<?> baseClass,
                     String name)
                       throws IllegalArgumentException

Gets statement from cache.

Statement is lazy loaded if not found in cache.

Parameters:

baseClass - statement base class

name - statement simple name

Returns:

statement

Throws:

IllegalArgumentException

getStatement

public Statement getStatement(ClassLoader classLoader,
                     String fullName)
                       throws StatementNotFoundException

Gets statement from cache.

Statement is lazy loaded if not found in cache.

Parameters:

classLoader - class loader to load statement

fullName - statement full file name

Returns:

statement

Throws:

StatementNotFoundException - if statement file not found

setEnableCache

public void setEnableCache(boolean enableCache)

Enable statement caching.

Caching is enabled by default.

Parameters:

enableCache - true to enable statement caching, false to disable

setDialect

public void setDialect(DatabaseDialect dialect)

Sets database dialect.

Parameters:

dialect - database dialect or null.