io.micronaut.data.model.query.builder

Class AbstractSqlLikeQueryBuilder

java.lang.Object

io.micronaut.data.model.query.builder.AbstractSqlLikeQueryBuilder

All Implemented Interfaces:

QueryBuilder

Direct Known Subclasses:

JpaQueryBuilder, SqlQueryBuilder

public abstract class AbstractSqlLikeQueryBuilder
extends java.lang.Object
implements QueryBuilder

An abstract class for builders that build SQL-like queries.

Since:

1.0.0

Author:

graemerocher

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractSqlLikeQueryBuilder.Placeholder Represents a placeholder in query.
protected class	AbstractSqlLikeQueryBuilder.PropertyPath Represents a path to a property.
protected static interface	AbstractSqlLikeQueryBuilder.QueryHandler A query handler.
protected class	AbstractSqlLikeQueryBuilder.QueryState The state of the query.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	AS_CLAUSE
protected static char	CLOSE_BRACKET
protected static char	COMMA
protected static java.lang.String	DELETE_CLAUSE
protected static char	DOT
protected static java.lang.String	FROM_CLAUSE
protected static java.lang.String	FUNCTION_COUNT
protected static java.lang.String	LOGICAL_AND
protected static java.lang.String	LOGICAL_OR
protected static java.lang.String	NOT_CLAUSE
protected static char	OPEN_BRACKET
static java.lang.String	ORDER_BY_CLAUSE
protected java.util.Map<java.lang.Class,AbstractSqlLikeQueryBuilder.QueryHandler>	queryHandlers
protected static java.lang.String	SELECT_CLAUSE
protected static char	SPACE
protected static java.lang.String	UPDATE_CLAUSE
protected static java.lang.String	WHERE_CLAUSE

Constructor Summary

Constructors

Constructor and Description
AbstractSqlLikeQueryBuilder()

Method Summary

Modifier and Type	Method and Description
protected java.lang.StringBuilder	appendDeleteClause(java.lang.StringBuilder queryString) Append the delete clause.
protected abstract void	appendProjectionRowCount(java.lang.StringBuilder queryString, java.lang.String logicalName) Appends a row count projection to the query string.
QueryResult	buildDelete(QueryModel query) Encode the given query into the encoded query instance.
protected abstract java.lang.String[]	buildJoin(java.lang.String alias, JoinPath joinPath, java.lang.String joinType, java.lang.StringBuilder stringBuilder, java.util.Map<java.lang.String,java.lang.String> appliedJoinPaths) Build a join expression for the given alias, association, join type and builder.
QueryResult	buildOrderBy(PersistentEntity entity, Sort sort) Encode the given query into the encoded query instance.
QueryResult	buildQuery(QueryModel query) Encode the given query into the encoded query instance.
QueryResult	buildUpdate(QueryModel query, java.util.List<java.lang.String> propertiesToUpdate) Encode the given query into the encoded query instance.
protected abstract boolean	computePropertyPaths() Whether property path expressions require computation by the implementation.
protected void	encodeInExpression(java.lang.StringBuilder whereClause, AbstractSqlLikeQueryBuilder.Placeholder placeholder) Placeholders for IN queries in SQL require special treatment.
protected abstract AbstractSqlLikeQueryBuilder.Placeholder	formatParameter(int index) Format the parameter at the given index.
java.lang.String	getAliasName(JoinPath joinPath) Get the alias name.
protected java.lang.String	getAliasName(PersistentEntity entity) Get an alias name for the given entity.
protected abstract java.lang.String	getColumnName(PersistentProperty persistentProperty) Get the column name for the given property.
protected java.lang.String	getPathOnlyAliasName(JoinPath joinPath) Get the alias name for just the join path.
protected java.lang.String	getTableAsKeyword() Get the AS keyword to use for table aliases.
protected abstract java.lang.String	getTableName(PersistentEntity entity) Get the table name for the given entity.
protected void	handleSubQuery(AbstractSqlLikeQueryBuilder.QueryState queryState, QueryModel.SubqueryCriterion subqueryCriterion, java.lang.String comparisonExpression) For handling subqueries.
protected abstract boolean	isAliasForBatch() Should aliases be used in batch statements.
abstract java.lang.String	resolveJoinType(Join.Type jt) Resolves the join type.
protected abstract void	selectAllColumns(AbstractSqlLikeQueryBuilder.QueryState queryState) Obtain the string that selects all columns from the entity.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.data.model.query.builder.QueryBuilder

buildInsert, buildPagination, newQueryBuilder

Field Detail

ORDER_BY_CLAUSE

public static final java.lang.String ORDER_BY_CLAUSE

See Also:

Constant Field Values

SELECT_CLAUSE

protected static final java.lang.String SELECT_CLAUSE

See Also:

Constant Field Values

AS_CLAUSE

protected static final java.lang.String AS_CLAUSE

See Also:

Constant Field Values

FROM_CLAUSE

protected static final java.lang.String FROM_CLAUSE

See Also:

Constant Field Values

WHERE_CLAUSE

protected static final java.lang.String WHERE_CLAUSE

See Also:

Constant Field Values

COMMA

protected static final char COMMA

See Also:

Constant Field Values

CLOSE_BRACKET

protected static final char CLOSE_BRACKET

See Also:

Constant Field Values

OPEN_BRACKET

protected static final char OPEN_BRACKET

See Also:

Constant Field Values

SPACE

protected static final char SPACE

See Also:

Constant Field Values

DOT

protected static final char DOT

See Also:

Constant Field Values

NOT_CLAUSE

protected static final java.lang.String NOT_CLAUSE

See Also:

Constant Field Values

LOGICAL_AND

protected static final java.lang.String LOGICAL_AND

See Also:

Constant Field Values

UPDATE_CLAUSE

protected static final java.lang.String UPDATE_CLAUSE

See Also:

Constant Field Values

DELETE_CLAUSE

protected static final java.lang.String DELETE_CLAUSE

See Also:

Constant Field Values

LOGICAL_OR

protected static final java.lang.String LOGICAL_OR

See Also:

Constant Field Values

FUNCTION_COUNT

protected static final java.lang.String FUNCTION_COUNT

See Also:

Constant Field Values

queryHandlers

protected final java.util.Map<java.lang.Class,AbstractSqlLikeQueryBuilder.QueryHandler> queryHandlers

Constructor Detail

AbstractSqlLikeQueryBuilder

public AbstractSqlLikeQueryBuilder()

Method Detail

encodeInExpression

protected void encodeInExpression(java.lang.StringBuilder whereClause,
                                  AbstractSqlLikeQueryBuilder.Placeholder placeholder)

Placeholders for IN queries in SQL require special treatment. This is handled at runtime by some wrapper implementations like JPAQL. But for raw queries the placeholder needs to be expanded to factor in the size of the list or array.

Parameters:

whereClause - The where clause

placeholder - The placeholder

buildQuery

@NonNull
public QueryResult buildQuery(@NonNull
                                       QueryModel query)

Description copied from interface: QueryBuilder

Encode the given query into the encoded query instance.

Specified by:

buildQuery in interface QueryBuilder

Parameters:

query - The query

Returns:

The encoded query

getTableName

protected abstract java.lang.String getTableName(PersistentEntity entity)

Get the table name for the given entity.

Parameters:

entity - The entity

Returns:

The table name

getAliasName

protected java.lang.String getAliasName(PersistentEntity entity)

Get an alias name for the given entity.

Parameters:

entity - The entity

Returns:

The alias name

getAliasName

public java.lang.String getAliasName(JoinPath joinPath)

Get the alias name.

Parameters:

joinPath - The join path

Returns:

The alias

getPathOnlyAliasName

@NonNull
protected java.lang.String getPathOnlyAliasName(JoinPath joinPath)

Get the alias name for just the join path.

Parameters:

joinPath - The join path

Returns:

The alias

buildJoin

protected abstract java.lang.String[] buildJoin(java.lang.String alias,
                                                JoinPath joinPath,
                                                java.lang.String joinType,
                                                java.lang.StringBuilder stringBuilder,
                                                java.util.Map<java.lang.String,java.lang.String> appliedJoinPaths)

Build a join expression for the given alias, association, join type and builder.

Parameters:

alias - The alias

joinPath - The join path

joinType - The join type string

stringBuilder - The target builder

appliedJoinPaths - The applied joins paths

Returns:

An array representing the aliases for each join association in the specified join path

getColumnName

protected abstract java.lang.String getColumnName(PersistentProperty persistentProperty)

Get the column name for the given property.

Parameters:

persistentProperty - The property

Returns:

The column name

selectAllColumns

protected abstract void selectAllColumns(AbstractSqlLikeQueryBuilder.QueryState queryState)

Obtain the string that selects all columns from the entity.

Parameters:

queryState - The query state

getTableAsKeyword

protected java.lang.String getTableAsKeyword()

Get the AS keyword to use for table aliases.

Returns:

The AS keyword if any

appendProjectionRowCount

protected abstract void appendProjectionRowCount(java.lang.StringBuilder queryString,
                                                 java.lang.String logicalName)

Appends a row count projection to the query string.

Parameters:

queryString - The query string

logicalName - The alias to the table name

handleSubQuery

protected void handleSubQuery(AbstractSqlLikeQueryBuilder.QueryState queryState,
                              QueryModel.SubqueryCriterion subqueryCriterion,
                              java.lang.String comparisonExpression)

For handling subqueries.

Parameters:

queryState - The query state

subqueryCriterion - The subquery criterion

comparisonExpression - The comparison expression

computePropertyPaths

protected abstract boolean computePropertyPaths()

Whether property path expressions require computation by the implementation. In a certain query dialects property paths are supported (such as JPA-QL where you can do select foo.bar) whilst for explicit SQL queries paths like this have to be computed into aliases / column name references.

Returns:

True if property path computation is required.

buildUpdate

@NonNull
public QueryResult buildUpdate(@NonNull
                                        QueryModel query,
                                        java.util.List<java.lang.String> propertiesToUpdate)

Description copied from interface: QueryBuilder

Encode the given query into the encoded query instance.

Specified by:

buildUpdate in interface QueryBuilder

Parameters:

query - The query

propertiesToUpdate - The property names to update

Returns:

The encoded query

buildDelete

@NonNull
public QueryResult buildDelete(@NonNull
                                        QueryModel query)

Description copied from interface: QueryBuilder

Encode the given query into the encoded query instance.

Specified by:

buildDelete in interface QueryBuilder

Parameters:

query - The query

Returns:

The encoded query

isAliasForBatch

protected abstract boolean isAliasForBatch()

Should aliases be used in batch statements.

Returns:

True if they should

appendDeleteClause

@NonNull
protected java.lang.StringBuilder appendDeleteClause(java.lang.StringBuilder queryString)

Append the delete clause.

Parameters:

queryString - The query string

Returns:

The delete clause

buildOrderBy

@NonNull
public QueryResult buildOrderBy(@NonNull
                                         PersistentEntity entity,
                                         @NonNull
                                         Sort sort)

Description copied from interface: QueryBuilder

Encode the given query into the encoded query instance.

Specified by:

buildOrderBy in interface QueryBuilder

Parameters:

entity - The root entity

sort - The sort

Returns:

The encoded query

formatParameter

protected abstract AbstractSqlLikeQueryBuilder.Placeholder formatParameter(int index)

Format the parameter at the given index.

Parameters:

index - The parameter

Returns:

The index

resolveJoinType

public abstract java.lang.String resolveJoinType(Join.Type jt)

Resolves the join type.

Parameters:

jt - The join type

Returns:

The join type.