sk.vracon.sqlcomments.core

Interface StatementConfiguration

All Known Implementing Classes:

StatementConfigurationAdapter

public interface StatementConfiguration

Basic interface representing statement configuration.

Statement configuration means mainly its name and parameters controlling creation of SQL string.

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.

Method Detail

statementName

String statementName()

Returns statement name.

Statement name can be represented in two ways:

1. baseClass() returns null - name must be full path to sql file including file extension.
2. 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.

Returns:

statement name.

See Also:

baseClass()

baseClass

Class<?> baseClass()

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.

Returns:

base class or null

See Also:

statementName()

generateParameterMap

Map<String,Object> generateParameterMap()

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 generateParametersAcceptingNull().

Returns:

parameters to construct statement

See Also:

generateParametersAcceptingNull()

generateParametersAcceptingNull

Set<String> generateParametersAcceptingNull()

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

This is useful mainly in Insert statements, rarely otherwise.

Returns:

parameters for which null doesn't mean to skip row

See Also:

generateParameterMap()

limit

Long limit()

Gets maximum number of rows to be loaded.

Returns:

limit

limit

void limit(Long limit)

Sets maximum number of rows to be loaded.

Parameters:

limit - limit

offset

Long offset()

Gets result set offset.

Returns:

offset

offset

void offset(Long offset)

Sets result set offset.

Parameters:

offset - offset