cz.ues.platform.commons.query

Interface UESQuerySQLBuilder

public interface UESQuerySQLBuilder

Builder for generating SQL from UES query.

Since:

UES6-06

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttributeMapping(java.lang.String attributeName, java.lang.String sqlPart, AttributeValueTransformer<?> valueTransformer, java.lang.String... additionalSqlParts) /** Specifies mapping of UES query attribute to SQL.
void	addAttributeMappingCustom(java.lang.String attributeName, AttributeToSQLStrategy<?> mappingStrategy) Specifies mapping of UES query attribute to SQL.
java.util.LinkedHashMap<java.lang.String,java.lang.Object>	getSqlParameters() Return the list of parameters prepared to be bound to the generated SQL.
java.lang.String	getSqlString() Return the generated SQL string.
void	process() Iterates over UES query AST tree and generates the SQL.

Method Detail

addAttributeMapping

void addAttributeMapping(java.lang.String attributeName,
java.lang.String sqlPart,
AttributeValueTransformer<?> valueTransformer,
java.lang.String... additionalSqlParts)

/** Specifies mapping of UES query attribute to SQL. It is used by SQL builder to generate dynamic part of SQL.

Parameters:

attributeName - name of the UES query attribute (as specified in the DTO, with @UESQueryAttribute annotation)

sqlPart - string directly placed in the generated SQL

valueTransformer - object converting value of an attribute specified in the UES query to the value for SQL.

additionalSqlParts -

Since:

UES6-06

addAttributeMappingCustom

void addAttributeMappingCustom(java.lang.String attributeName,
AttributeToSQLStrategy<?> mappingStrategy)

Specifies mapping of UES query attribute to SQL. It is used by SQL builder to generate dynamic part of SQL. This is the more general form of mapping specification.

Parameters:

attributeName - name of the UES query attribute (as specified in the DTO, with @UESQueryAttribute annotation)

mappingStrategy - object used for generating SQL in "where" and "order by" SQL clauses

Since:

UES6-06

process

void process()

Iterates over UES query AST tree and generates the SQL. This method should be executed just once.

Since:

UES6-06

getSqlString

java.lang.String getSqlString()

Return the generated SQL string.

Returns:

the generated SQL string

Since:

UES6-06

getSqlParameters

java.util.LinkedHashMap<java.lang.String,java.lang.Object> getSqlParameters()

Return the list of parameters prepared to be bound to the generated SQL.

Returns:

the list of parameters for the SQL

Since:

UES6-06