sk.vracon.sqlcomments.core.impl

Class StatementConfigurationAdapter

java.lang.Object

sk.vracon.sqlcomments.core.impl.StatementConfigurationAdapter

All Implemented Interfaces:

StatementConfiguration

public abstract class StatementConfigurationAdapter
extends Object
implements StatementConfiguration

Empty implementation of StatementConfiguration.

Constructor Summary

Constructors

Constructor and Description
StatementConfigurationAdapter(String statementName, Class<?> baseClass) Creates instance of configuration with mandatory fields.

Method Summary

Methods

Modifier and Type	Method and Description
Class<?>	baseClass() Returns base class.
Map<String,Object>	generateParameterMap() Map of parameters to construct statement in runtime.
Set<String>	generateParametersAcceptingNull() Returns parameters for which null doesn't mean to skip row.
Long	limit() Gets maximum number of rows to be loaded.
void	limit(Long limit) Sets maximum number of rows to be loaded.
Long	offset() Gets result set offset.
void	offset(Long offset) Sets result set offset.
String	statementName() Returns statement name.

Methods inherited from class java.lang.Object

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

Constructor Detail

StatementConfigurationAdapter

public StatementConfigurationAdapter(String statementName,
                             Class<?> baseClass)

Creates instance of configuration with mandatory fields.

Parameters:

statementName - statement name

baseClass - base class

Method Detail

statementName

public String statementName()

Description copied from interface: StatementConfiguration

Returns statement name.

Statement name can be represented in two ways:

1. StatementConfiguration.baseClass() returns null - name must be full path to sql file including file extension.
2. StatementConfiguration.baseClass() returns real class - name is just a part of path. Full name (and full path) is concatenation of base classes' path this name and .sql extension.

Statement name may not be null.

Specified by:

statementName in interface StatementConfiguration

Returns:

statement name.

See Also:

StatementConfiguration.baseClass()

baseClass

public Class<?> baseClass()

Description copied from interface: StatementConfiguration

Returns base class.

Base class has two functions:

1. Class name is used as a prefix of statement file name.
2. Class loader of this class is used also to load statement file.

Statements generated from java comments use as a base class the same class from which they were extracted.

Specified by:

baseClass in interface StatementConfiguration

Returns:

base class or null

See Also:

StatementConfiguration.statementName()

generateParameterMap

public Map<String,Object> generateParameterMap()

Description copied from interface: StatementConfiguration

Map of parameters to construct statement in runtime.

Map contains parameters which can be used as each of three possibilities:

• SQL parameter
• Script parameter
• Replacement

In runtime if parameter is used as a SQL parameter and has null value or is missing at all - it means to skip statement row. Exception to this rule are parameters returned by StatementConfiguration.generateParametersAcceptingNull().

Specified by:

generateParameterMap in interface StatementConfiguration

Returns:

parameters to construct statement

See Also:

StatementConfiguration.generateParametersAcceptingNull()

generateParametersAcceptingNull

public Set<String> generateParametersAcceptingNull()

Description copied from interface: StatementConfiguration

Returns parameters for which null doesn't mean to skip row.

This is useful mainly in Insert statements, rarely otherwise.

Specified by:

generateParametersAcceptingNull in interface StatementConfiguration

Returns:

parameters for which null doesn't mean to skip row

See Also:

StatementConfiguration.generateParameterMap()

limit

public Long limit()

Description copied from interface: StatementConfiguration

Gets maximum number of rows to be loaded.

Specified by:

limit in interface StatementConfiguration

Returns:

limit

limit

public void limit(Long limit)

Description copied from interface: StatementConfiguration

Sets maximum number of rows to be loaded.

Specified by:

limit in interface StatementConfiguration

Parameters:

limit - limit

offset

public Long offset()

Description copied from interface: StatementConfiguration

Gets result set offset.

Specified by:

offset in interface StatementConfiguration

Returns:

offset

offset

public void offset(Long offset)

Description copied from interface: StatementConfiguration

Sets result set offset.

Specified by:

offset in interface StatementConfiguration

Parameters:

offset - offset