Package io.micronaut.data.model.query.builder.jpa

Class JpaQueryBuilder2

java.lang.Object

io.micronaut.data.model.query.builder.sql.AbstractSqlLikeQueryBuilder2

io.micronaut.data.model.query.builder.jpa.JpaQueryBuilder2

All Implemented Interfaces:

QueryBuilder2

@Internal
public final class JpaQueryBuilder2
extends AbstractSqlLikeQueryBuilder2

Builds JPA 1.0 String-based queries from the Query model.

Since:

1.0

Author:

Graeme Rocher, Denis Stepanov

Nested Class Summary

Nested classes/interfaces inherited from class io.micronaut.data.model.query.builder.sql.AbstractSqlLikeQueryBuilder2

AbstractSqlLikeQueryBuilder2.ExpressionAppender, AbstractSqlLikeQueryBuilder2.Placeholder, AbstractSqlLikeQueryBuilder2.QueryBuilder, AbstractSqlLikeQueryBuilder2.QueryPosition, AbstractSqlLikeQueryBuilder2.QueryPropertyPath, AbstractSqlLikeQueryBuilder2.QueryState, AbstractSqlLikeQueryBuilder2.SqlPredicateVisitor, AbstractSqlLikeQueryBuilder2.SqlSelectionVisitor

Nested classes/interfaces inherited from interface io.micronaut.data.model.query.builder.QueryBuilder2

QueryBuilder2.BaseQueryDefinition, QueryBuilder2.DeleteQueryDefinition, QueryBuilder2.InsertQueryDefinition, QueryBuilder2.SelectQueryDefinition, QueryBuilder2.UpdateQueryDefinition

Field Summary

Fields inherited from class io.micronaut.data.model.query.builder.sql.AbstractSqlLikeQueryBuilder2

ALIAS_REPLACE_QUOTED, AND, AS_CLAUSE, CANNOT_QUERY_ON_ID_WITH_ENTITY_THAT_HAS_NO_ID, CLOSE_BRACKET, COMMA, DISTINCT, DOT, FROM_CLAUSE, LOGICAL_AND, LOGICAL_OR, NOT, OPEN_BRACKET, OR, ORDER_BY_CLAUSE, RETURNING, SELECT_CLAUSE, SPACE, WHERE_CLAUSE

Constructor Summary

Constructors

Constructor	Description
JpaQueryBuilder2()	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected @NonNull StringBuilder	appendDeleteClause(StringBuilder queryString)	Append the delete clause.
protected void	appendLimitAndOffset(Dialect dialect, long limit, long offset, StringBuilder builder)	Append limit and offset.
protected void	appendLimitAndOrder(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, QueryBuilder2.SelectQueryDefinition definition, boolean appendLimit, boolean appendOrder, AbstractSqlLikeQueryBuilder2.QueryState queryState)
protected String	buildAdditionalWhereClause(AbstractSqlLikeQueryBuilder2.QueryState queryState, io.micronaut.core.annotation.AnnotationMetadata annotationMetadata)	Builds additional where clause if there is Where annotation on the entity.
QueryResult	buildInsert(io.micronaut.core.annotation.AnnotationMetadata repositoryMetadata, QueryBuilder2.InsertQueryDefinition definition)	Builds an insert statement for the given entity.
protected void	buildJoin(String joinType, StringBuilder query, AbstractSqlLikeQueryBuilder2.QueryState queryState, PersistentAssociationPath joinAssociation, PersistentEntity associationOwner, String currentJoinAlias, String lastJoinAlias)	Build a join expression for the given alias, association, join type and builder.
String	buildLimitAndOffset(long limit, long offset)	Generate the limit and offset query.
protected boolean	computePropertyPaths()	Whether property path expressions require computation by the implementation.
protected AbstractSqlLikeQueryBuilder2.SqlSelectionVisitor	createSelectionVisitor(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, AbstractSqlLikeQueryBuilder2.QueryState queryState, boolean distinct)	Create a selection visitor.
protected AbstractSqlLikeQueryBuilder2.Placeholder	formatParameter(int index)	Format the parameter at the given index.
String	getAliasName(PersistentEntity entity)	Get an alias name for the given entity.
protected String	getColumnName(PersistentProperty persistentProperty)	Get the column name for the given property.
protected NamingStrategy	getNamingStrategy(PersistentEntity entity)	Gets NamingStrategy for the entity.
protected NamingStrategy	getNamingStrategy(PersistentPropertyPath propertyPath)	Gets NamingStrategy for the property path.
protected String	getTableName(PersistentEntity entity)	Get the table name for the given entity.
protected boolean	isAliasForBatch(PersistentEntity persistentEntity, io.micronaut.core.annotation.AnnotationMetadata annotationMetadata)	Should aliases be used in batch statements.
protected String	quote(String persistedName)	Quote a column name for the dialect.
String	resolveJoinType(Join.Type jt)	Resolves the join type.
protected boolean	shouldAppendOrder(QueryBuilder2.SelectQueryDefinition definition)	Should append order.
protected boolean	supportsLimitQuery()

Methods inherited from class io.micronaut.data.model.query.builder.sql.AbstractSqlLikeQueryBuilder2

appendExpression, appendForUpdate, appendOrder, appendPropertyRef, appendTransformed, appendUpdateSetParameter, asLiteral, asPath, asQueryPropertyPath, buildAdditionalWhereString, buildAdditionalWhereString, buildDelete, buildOrderBy, buildPropertyByName, buildQuery, buildSelect, buildSelect, buildUpdate, buildWhereClause, checkDialectSupportsJsonEntity, createPredicateVisitor, getAliasName, getColumnAlias, getDataTransformerReadValue, getDataTransformerWriteValue, getDialect, getMappedName, getMappedName, getMappedName, getPathOnlyAliasName, getTableAsKeyword, getUnescapedTableName, isJsonEntity, newBindingContext, parameterInRoleModifiesLimit, parameterInRoleModifiesOrder, quote, resolveWhereForAnnotationMetadata, shouldEscape, traverseEmbedded

Methods inherited from class java.lang.Object

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

Constructor Details

JpaQueryBuilder2

public JpaQueryBuilder2()

Default constructor.

Method Details

quote

protected String quote(String persistedName)

Description copied from class: AbstractSqlLikeQueryBuilder2

Quote a column name for the dialect.

Overrides:

quote in class AbstractSqlLikeQueryBuilder2

Parameters:

persistedName - The persisted name.

Returns:

The quoted name

getAliasName

public String getAliasName(PersistentEntity entity)

Description copied from class: AbstractSqlLikeQueryBuilder2

Get an alias name for the given entity.

Overrides:

getAliasName in class AbstractSqlLikeQueryBuilder2

Parameters:

entity - The entity

Returns:

The alias name

buildJoin

protected void buildJoin(String joinType,
 StringBuilder query,
 AbstractSqlLikeQueryBuilder2.QueryState queryState,
 PersistentAssociationPath joinAssociation,
 PersistentEntity associationOwner,
 String currentJoinAlias,
 String lastJoinAlias)

Description copied from class: AbstractSqlLikeQueryBuilder2

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

Overrides:

buildJoin in class AbstractSqlLikeQueryBuilder2

Parameters:

joinType - The join type

query - The query builder

queryState - The state

joinAssociation - The association

associationOwner - The associated owner

currentJoinAlias - The current join alias

lastJoinAlias - The last join alias

buildAdditionalWhereClause

protected String buildAdditionalWhereClause(AbstractSqlLikeQueryBuilder2.QueryState queryState,
 io.micronaut.core.annotation.AnnotationMetadata annotationMetadata)

Description copied from class: AbstractSqlLikeQueryBuilder2

Builds additional where clause if there is Where annotation on the entity.

Overrides:

buildAdditionalWhereClause in class AbstractSqlLikeQueryBuilder2

Parameters:

queryState - the query state

annotationMetadata - the annotation metadata

Returns:

where clause if there was Where annotation on the entity (or joins for JPA implementation)

getTableName

protected String getTableName(PersistentEntity entity)

Description copied from class: AbstractSqlLikeQueryBuilder2

Get the table name for the given entity.

Specified by:

getTableName in class AbstractSqlLikeQueryBuilder2

Parameters:

entity - The entity

Returns:

The table name

getColumnName

protected String getColumnName(PersistentProperty persistentProperty)

Description copied from class: AbstractSqlLikeQueryBuilder2

Get the column name for the given property.

Specified by:

getColumnName in class AbstractSqlLikeQueryBuilder2

Parameters:

persistentProperty - The property

Returns:

The column name

createSelectionVisitor

protected AbstractSqlLikeQueryBuilder2.SqlSelectionVisitor createSelectionVisitor(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata,
 AbstractSqlLikeQueryBuilder2.QueryState queryState,
 boolean distinct)

Description copied from class: AbstractSqlLikeQueryBuilder2

Create a selection visitor.

Overrides:

createSelectionVisitor in class AbstractSqlLikeQueryBuilder2

Parameters:

annotationMetadata - The annotation metadata

queryState - The query state

distinct - The distinct

Returns:

The visitor

computePropertyPaths

protected boolean computePropertyPaths()

Description copied from class: AbstractSqlLikeQueryBuilder2

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.

Specified by:

computePropertyPaths in class AbstractSqlLikeQueryBuilder2

Returns:

True if property path computation is required.

isAliasForBatch

protected boolean isAliasForBatch(PersistentEntity persistentEntity,
 io.micronaut.core.annotation.AnnotationMetadata annotationMetadata)

Description copied from class: AbstractSqlLikeQueryBuilder2

Should aliases be used in batch statements.

Specified by:

isAliasForBatch in class AbstractSqlLikeQueryBuilder2

Parameters:

persistentEntity - the persistent entity

annotationMetadata - the method annotation metadata

Returns:

True if they should

formatParameter

protected AbstractSqlLikeQueryBuilder2.Placeholder formatParameter(int index)

Description copied from class: AbstractSqlLikeQueryBuilder2

Format the parameter at the given index.

Specified by:

formatParameter in class AbstractSqlLikeQueryBuilder2

Parameters:

index - The parameter

Returns:

The index

resolveJoinType

public String resolveJoinType(Join.Type jt)

Description copied from class: AbstractSqlLikeQueryBuilder2

Resolves the join type.

Specified by:

resolveJoinType in class AbstractSqlLikeQueryBuilder2

Parameters:

jt - The join type

Returns:

The join type.

buildInsert

public QueryResult buildInsert(io.micronaut.core.annotation.AnnotationMetadata repositoryMetadata,
 QueryBuilder2.InsertQueryDefinition definition)

Description copied from interface: QueryBuilder2

Builds an insert statement for the given entity.

Parameters:

repositoryMetadata - The repository annotation metadata

definition - The definition

Returns:

The insert statement or null if the implementation doesn't require insert statements

appendDeleteClause

@NonNull
protected @NonNull StringBuilder appendDeleteClause(StringBuilder queryString)

Description copied from class: AbstractSqlLikeQueryBuilder2

Append the delete clause.

Overrides:

appendDeleteClause in class AbstractSqlLikeQueryBuilder2

Parameters:

queryString - The query string

Returns:

The delete clause

buildLimitAndOffset

public String buildLimitAndOffset(long limit,
 long offset)

Description copied from interface: QueryBuilder2

Generate the limit and offset query.

Specified by:

buildLimitAndOffset in interface QueryBuilder2

Overrides:

buildLimitAndOffset in class AbstractSqlLikeQueryBuilder2

Parameters:

limit - The limit (-1 of not set)

offset - The offset (0 if not set)

Returns:

The encoded query

appendLimitAndOffset

protected void appendLimitAndOffset(Dialect dialect,
 long limit,
 long offset,
 StringBuilder builder)

Description copied from class: AbstractSqlLikeQueryBuilder2

Append limit and offset.

Overrides:

appendLimitAndOffset in class AbstractSqlLikeQueryBuilder2

Parameters:

dialect - The dialect

limit - The limit

offset - The offset

builder - The builder

supportsLimitQuery

protected boolean supportsLimitQuery()

Overrides:

supportsLimitQuery in class AbstractSqlLikeQueryBuilder2

Returns:

True if limit is supported in the query

appendLimitAndOrder

protected void appendLimitAndOrder(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata,
 QueryBuilder2.SelectQueryDefinition definition,
 boolean appendLimit,
 boolean appendOrder,
 AbstractSqlLikeQueryBuilder2.QueryState queryState)

Overrides:

appendLimitAndOrder in class AbstractSqlLikeQueryBuilder2

shouldAppendOrder

protected boolean shouldAppendOrder(QueryBuilder2.SelectQueryDefinition definition)

Description copied from class: AbstractSqlLikeQueryBuilder2

Should append order.

Overrides:

shouldAppendOrder in class AbstractSqlLikeQueryBuilder2

Parameters:

definition - The definition

Returns:

true if should

getNamingStrategy

protected NamingStrategy getNamingStrategy(PersistentEntity entity)

Description copied from class: AbstractSqlLikeQueryBuilder2

Gets NamingStrategy for the entity. Subclasses might override and potentially provide different strategy in some cases.

Overrides:

getNamingStrategy in class AbstractSqlLikeQueryBuilder2

Parameters:

entity - the persistent entity

Returns:

naming strategy for the entity

getNamingStrategy

protected NamingStrategy getNamingStrategy(PersistentPropertyPath propertyPath)

Description copied from class: AbstractSqlLikeQueryBuilder2

Gets NamingStrategy for the property path. Subclasses might override and potentially provide different strategy in some cases.

Overrides:

getNamingStrategy in class AbstractSqlLikeQueryBuilder2

Parameters:

propertyPath - the property path representation

Returns:

naming strategy for the property path