Spring/spring-data-gemfire
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

SGF-534 - Fix ordered GemfireRepository.findAll(:Sort) queries.

Browse Source
This commit is contained in:
John Blum
2016-09-22 22:28:57 -07:00
parent 17418c5bdd
commit a68a31a052
12 changed files with 694 additions and 247 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
src/main/java/org/springframework/data/gemfire/repository/query/QueryBuilder.java
View File

@@ -13,14 +13,16 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.gemfire.repository.query;
import org.springframework.data.gemfire.mapping.GemfirePersistentEntity;
import org.springframework.data.gemfire.repository.query.support.OqlKeyword;
import org.springframework.data.repository.query.parser.PartTree;
import org.springframework.util.Assert;
/**
* The QueryBuilder class is used to build a QueryString.
* The QueryBuilder class is used to build a {@link QueryString}.
*
* @author Oliver Gierke
* @author David Turanski
@@ -30,22 +32,73 @@ import org.springframework.util.Assert;
class QueryBuilder {
static final String DEFAULT_ALIAS = "x";
static final String SELECT_OQL_TEMPLATE = "SELECT %1$s * FROM /%2$s %3$s";
static final String WHERE_CLAUSE_TEMPLATE = "%1$s WHERE %2$s";
private final String query;
public QueryBuilder(String source) {
Assert.hasText(source, "The OQL Query must be specified");
this.query = source;
/* (non-Javadoc) */
static String asQuery(GemfirePersistentEntity<?> entity, PartTree tree) {
return String.format(SELECT_OQL_TEMPLATE, (tree.isDistinct() ? OqlKeyword.DISTINCT : ""),
entity.getRegionName(), DEFAULT_ALIAS).replaceAll("\\s{2,}", " ");
}
/* (non-Javadoc) */
static String validateQuery(String query) {
Assert.hasText(query, "An OQL Query must be specified");
return query;
}
/**
* Constructs an instance of {@link QueryBuilder} initialized with the given query {@link String}.
*
* @param query {@link String} containing the base OQL query.
* @see #validateQuery(String)
*/
public QueryBuilder(String query) {
this.query = validateQuery(query);
}
/**
* Constructs an instance of {@link QueryBuilder} with the given {@link GemfirePersistentEntity}
* and {@link PartTree} that determines the GemFire {@link com.gemstone.gemfire.cache.Region}
* to query and whether the query should capture unique results.
*
* @param entity {@link GemfirePersistentEntity} used to determine the GemFire
* {@link com.gemstone.gemfire.cache.Region} to query.
* @param tree {@link PartTree} containing parts of the OQL Query for determining things
* like uniqueness.
* @see org.springframework.data.gemfire.mapping.GemfirePersistentEntity
* @see org.springframework.data.repository.query.parser.PartTree
*/
public QueryBuilder(GemfirePersistentEntity<?> entity, PartTree tree) {
this(String.format("SELECT%1$s * FROM /%2$s %3$s", (tree.isDistinct() ? " DISTINCT" : ""),
entity.getRegionName(), DEFAULT_ALIAS));
this(asQuery(entity, tree));
}
/**
* Constructs a {@link QueryString} with the given {@link Predicate}.
*
* @param predicate {@link Predicate} to append to the query.
* @return a {@link QueryString} with the base OQL query and {@link Predicate}.
* @see org.springframework.data.gemfire.repository.query.Predicate
* @see #withPredicate(String, Predicate)
*/
public QueryString create(Predicate predicate) {
return new QueryString(predicate != null ? String.format("%1$s WHERE %2$s", query,
predicate.toString(DEFAULT_ALIAS)) : query);
return new QueryString(withPredicate(this.query, predicate));
}
/**
* Appends the given {@link Predicate} to the given {@code query} {@link String}.
*
* @param query {@link String} containing the query.
* @param predicate {@link Predicate} to append to the query.
* @return a {@link String} containing the query with the {@link Predicate} appended,
* or just a {@link String} containing the query if the {@link Predicate} is {@literal null}.
* @see org.springframework.data.gemfire.repository.query.Predicate
*/
protected String withPredicate(String query, Predicate predicate) {
return (predicate == null ? query
: String.format(WHERE_CLAUSE_TEMPLATE, query, predicate.toString(DEFAULT_ALIAS)));
}
/*
@@ -54,6 +107,6 @@ class QueryBuilder {
*/
@Override
public String toString() {
return query;
return this.query;
}
}

138
src/main/java/org/springframework/data/gemfire/repository/query/QueryString.java
View File

@@ -21,15 +21,16 @@ import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import com.gemstone.gemfire.cache.Region;
import org.springframework.data.domain.Sort;
import org.springframework.data.gemfire.repository.query.support.OqlKeyword;
import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;
import org.springframework.util.StringUtils;
import com.gemstone.gemfire.cache.Region;
/**
* Value object to work with OQL query strings.
* The QueryString class is a utility class for working with GemFire OQL query statement syntax.
*
* @author Oliver Gierke
* @author David Turanski
@@ -43,52 +44,74 @@ public class QueryString {
protected static final Pattern TRACE_PATTERN = Pattern.compile("<TRACE>");
// OQL Query Templates
private static final String HINTS_QUERY_TEMPLATE = "<HINT %1$s> %2$s";
private static final String IMPORT_QUERY_TEMPLATE = "IMPORT %1$s; %2$s";
private static final String LIMIT_QUERY_TEMPLATE = "%1$s LIMIT %2$d";
private static final String SELECT_QUERY_TEMPLATE = "SELECT %1$s FROM /%2$s";
private static final String TRACE_QUERY_TEMPLATE = "<TRACE> %1$s";
private static final String HINTS_OQL_TEMPLATE = "<HINT %1$s> %2$s";
private static final String IMPORT_OQL_TEMPLATE = "IMPORT %1$s; %2$s";
private static final String LIMIT_OQL_TEMPLATE = "%1$s LIMIT %2$d";
private static final String SELECT_OQL_TEMPLATE = "SELECT %1$s FROM /%2$s";
private static final String TRACE_OQL_TEMPLATE = "<TRACE> %1$s";
// Query Regular Expression Patterns
// OQL Query Regular Expression Patterns
private static final String IN_PATTERN = "(?<=IN (SET|LIST) )\\$\\d";
private static final String IN_PARAMETER_PATTERN = "(?<=IN (SET|LIST) \\$)\\d";
private static final String REGION_PATTERN = "\\/(\\/?\\w)+";
private final String query;
/**
* Creates a {@link QueryString} from the given {@link String} query.
*
* @param source a String containing the OQL Query.
*/
public QueryString(String source) {
Assert.hasText(source, "The OQL statement (Query) to execute must be specified!");
this.query = source;
/* (non-Javadoc) */
static String asQuery(Class<?> domainType, boolean isCountQuery) {
return String.format(SELECT_OQL_TEMPLATE, (isCountQuery ? "count(*)" : "*"),
validateDomainType(domainType).getSimpleName());
}
/* (non-Javadoc) */
static <T> Class<T> validateDomainType(Class<T> domainType) {
Assert.notNull(domainType, "domainType must not be null");
return domainType;
}
/* (non-Javadoc) */
static String validateQuery(String query) {
Assert.hasText(query, "An OQL Query must be specified");
return query;
}
/**
* Creates a {@literal SELECT} query for the given domain class.
* Constructs an instance of {@link QueryString} initialized with the given GemFire OQL Query {@link String}.
*
* @param domainClass must not be {@literal null}.
* @param query {@link String} specifying the GemFire OQL Query.
* @throws IllegalArgumentException if the query string is unspecified (null or empty).
*/
public QueryString(String query) {
this.query = validateQuery(query);
}
/**
* Constructs a GemFire OQL {@literal SELECT} Query for the given domain class.
*
* @param domainType application domain object type to query; must not be {@literal null}.
* @see #QueryString(Class, boolean)
*/
@SuppressWarnings("unused")
public QueryString(Class<?> domainClass) {
this(domainClass, false);
public QueryString(Class<?> domainType) {
this(domainType, false);
}
/**
* Creates a {@literal SELECT} query for the given domain class.
* Constructs a GemFire OQL {@literal SELECT} Query for the given domain class. {@code isCountQuery} indicates
* whether to select a count or select the contents of the objects of the given domain object type.
*
* @param domainClass must not be {@literal null}.
* @param isCountQuery indicates if this is a count query
* @param domainType application domain object type to query; must not be {@literal null}.
* @param isCountQuery boolean value to indicate if this is a count query.
* @throws IllegalArgumentException if {@code domainType} is null.
* @see #QueryString(String)
*/
public QueryString(Class<?> domainClass, boolean isCountQuery) {
this(String.format(SELECT_QUERY_TEMPLATE, (isCountQuery ? "count(*)" : "*"), domainClass.getSimpleName()));
public QueryString(Class<?> domainType, boolean isCountQuery) {
this(asQuery(domainType, isCountQuery));
}
/**
* Binds the given values to the {@literal IN} parameter keyword by expanding the given values into a comma-separated
* {@link String}.
* Binds the given {@link Collection} of values into the {@literal IN} parameters of the OQL Query by expanding
* the given values into a comma-separated {@link String}.
*
* @param values the values to bind, returns the {@link QueryString} as is if {@literal null} is given.
* @return a Query String having "in" parameters bound with values.
@@ -96,7 +119,7 @@ public class QueryString {
public QueryString bindIn(Collection<?> values) {
if (values != null) {
String valueString = StringUtils.collectionToDelimitedString(values, ", ", "'", "'");
return new QueryString(query.replaceFirst(IN_PATTERN, String.format("(%s)", valueString)));
return new QueryString(this.query.replaceFirst(IN_PATTERN, String.format("(%s)", valueString)));
}
return this;
@@ -113,7 +136,7 @@ public class QueryString {
*/
@SuppressWarnings("unused")
public QueryString forRegion(Class<?> domainClass, Region<?, ?> region) {
return new QueryString(query.replaceAll(REGION_PATTERN, region.getFullPath()));
return new QueryString(this.query.replaceAll(REGION_PATTERN, region.getFullPath()));
}
/**
@@ -135,11 +158,11 @@ public class QueryString {
}
/**
* Appends the Sort order to this GemFire OQL Query string.
* Appends the {@link Sort} order to this GemFire OQL Query string.
*
* @param sort the Sort object indicating the order by criteria.
* @return this QueryString with an ORDER BY clause if the Sort object is not null, or this QueryString as-is
* if the Sort object is null.
* @param sort {@link Sort} indicating the order of the query results.
* @return a new {@link QueryString} with an ORDER BY clause if {@link Sort} is not {@literal null},
* or this {@link QueryString} as-is if {@link Sort} is {@literal null}.
* @see org.springframework.data.domain.Sort
* @see org.springframework.data.gemfire.repository.query.QueryString
*/
@@ -153,12 +176,30 @@ public class QueryString {
orderClause.append(String.format("%1$s %2$s", order.getProperty(), order.getDirection()));
}
return new QueryString(String.format("%1$s %2$s", this.query, orderClause.toString()));
return new QueryString(String.format("%1$s %2$s", makeDistinct(this.query), orderClause.toString()));
}
return this;
}
/**
* Replaces the SELECT query with a SELECT DISTINCT query if the query does not contain the DISTINCT OQL keyword.
*
* @param query {@link String} containing the query to evaluate.
* @return a SELECT DISTINCT query if {@code query} does not contain the DISTINCT OQL keyword.
*/
String makeDistinct(String query) {
return (query.contains(OqlKeyword.DISTINCT.getKeyword()) ? query
: query.replaceFirst(OqlKeyword.SELECT.getKeyword(),
String.format("%1$s %2$s", OqlKeyword.SELECT.getKeyword(), OqlKeyword.DISTINCT.getKeyword())));
}
/**
* Applies HINTS to the OQL Query.
*
* @param hints array of {@link String Strings} containing query hints.
* @return a new {@link QueryString} if hints are not null or empty, or return this {@link QueryString}.
*/
public QueryString withHints(String... hints) {
if (!ObjectUtils.isEmpty(hints)) {
StringBuilder builder = new StringBuilder();
@@ -168,23 +209,40 @@ public class QueryString {
builder.append(String.format("'%1$s'", hint));
}
return new QueryString(String.format(HINTS_QUERY_TEMPLATE, builder.toString(), query));
return new QueryString(String.format(HINTS_OQL_TEMPLATE, builder.toString(), query));
}
return this;
}
/**
* Applies an IMPORT to the OQL Query.
*
* @param importExpression {@link String} containing the import clause.
* @return a new {@link QueryString} if an import was declared, or return this {@link QueryString}.
*/
public QueryString withImport(String importExpression) {
return (StringUtils.hasText(importExpression) ? new QueryString(
String.format(IMPORT_QUERY_TEMPLATE, importExpression, query)) : this);
return (StringUtils.hasText(importExpression) ?
new QueryString(String.format(IMPORT_OQL_TEMPLATE, importExpression, query)) : this);
}
/**
* Applies a LIMIT to the OQL Query.
*
* @param limit {@link Integer} indicating the number of results to return from the query.
* @return a new {@link QueryString} if a limit was specified, or return this {@link QueryString}.
*/
public QueryString withLimit(Integer limit) {
return (limit != null ? new QueryString(String.format(LIMIT_QUERY_TEMPLATE, query, limit)) : this);
return (limit != null ? new QueryString(String.format(LIMIT_OQL_TEMPLATE, query, limit)) : this);
}
/**
* Applies TRACE logging to the OQL Query.
*
* @return a new {@link QueryString} with tracing enabled.
*/
public QueryString withTrace() {
return new QueryString(String.format(TRACE_QUERY_TEMPLATE, query));
return new QueryString(String.format(TRACE_OQL_TEMPLATE, query));
}
/*

111
src/main/java/org/springframework/data/gemfire/repository/query/support/OqlKeyword.java Normal file
View File

@@ -0,0 +1,111 @@
/*
* Copyright 2012 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.springframework.data.gemfire.repository.query.support;
import org.springframework.util.StringUtils;
/**
* The OqlKeyword enum represents the range of keywords (Reserved Words)
* in GemFire's Object Query Language (OQL).
*
* @author John Blum
* @see <a href="http://gemfire.docs.pivotal.io/docs-gemfire/latest/developing/query_additional/supported_keywords.html">Supported Keywords</a>
* @since 1.0.0
*/
public enum OqlKeyword {
AND,
AS,
COUNT,
DISTINCT,
ELEMENT,
FROM,
HINT,
IMPORT,
IN,
IS_DEFINED,
IS_UNDEFINED,
LIMIT,
LIKE,
NOT,
NVL,
OR,
ORDER_BY("ORDER BY"),
SELECT,
SET,
TRACE,
TO_DATE,
TYPE,
WHERE;
private final String keyword;
/**
* Constructs an instance of the GemFire {@link OqlKeyword} enumerate value with an unspecified keyword.
* When the keyword is unspecified, it defaults to the {@link #name()} of the {@link OqlKeyword}.
*
* @see #OqlKeyword(String)
*/
OqlKeyword() {
this(null);
}
/**
* Constructs an {@link OqlKeyword} enumerated value with the given GemFire OQL Keyword.
*
* @param keyword {@link String} specifying the GemFire OQL Keyword;
* can be {@literal null}.
*/
OqlKeyword(String keyword) {
this.keyword = keyword;
}
/**
* Looks up an {@link OqlKeyword} for the given {@code keyword} {@link String}.
*
* @param keyword name of the GemFire OQL Keyword to lookup.
* @return an {@link OqlKeyword} enumerated value for the given {@code keyword} {@link String}.
* @throws IllegalArgumentException if {@code keyword} is not a valid GemFire OQL Keyword.
*/
public static OqlKeyword valueOfIgnoreCase(String keyword) {
for (OqlKeyword oqlKeyword : values()) {
if (oqlKeyword.getKeyword().equalsIgnoreCase(StringUtils.trimWhitespace(keyword))) {
return oqlKeyword;
}
}
throw new IllegalArgumentException(String.format("[%s] is not a valid GemFire OQL Keyword", keyword));
}
/**
* Returns name of this GemFire OQL Keyword enumerated value. The keyword may have been
* explicitly defined when the {@link OqlKeyword} enumerated value was constructed, in which case
* this value is returned, otherwise this method returns {@link OqlKeyword#name()}.
*
* @return a {@link String} name for this GemFire OQL Keyword enumerated value.
* @see #name()
*/
public String getKeyword() {
return (StringUtils.hasText(this.keyword) ? this.keyword : name());
}
/* (non-Javadoc) */
@Override
public String toString() {
return getKeyword();
}
}

22
src/main/java/org/springframework/data/gemfire/repository/support/SimpleGemfireRepository.java
View File

@@ -39,7 +39,7 @@ import com.gemstone.gemfire.cache.query.SelectResults;
/**
* Basic Repository implementation for GemFire.
*
*
* @author Oliver Gierke
* @author David Turanski
* @author John Blum
@@ -56,12 +56,12 @@ public class SimpleGemfireRepository<T, ID extends Serializable> implements Gemf
/**
* Creates a new {@link SimpleGemfireRepository}.
*
*
* @param template must not be {@literal null}.
* @param entityInformation must not be {@literal null}.
*/
public SimpleGemfireRepository(GemfireTemplate template, EntityInformation<T, ID> entityInformation) {
Assert.notNull(template);
Assert.notNull(entityInformation);
@@ -71,7 +71,7 @@ public class SimpleGemfireRepository<T, ID extends Serializable> implements Gemf
/*
* (non-Javadoc)
*
*
* @see org.springframework.data.repository.CrudRepository#save(S)
*/
@Override
@@ -82,7 +82,7 @@ public class SimpleGemfireRepository<T, ID extends Serializable> implements Gemf
/*
* (non-Javadoc)
*
*
* @see org.springframework.data.repository.CrudRepository#save(java.lang.Iterable)
*/
@Override
@@ -123,7 +123,7 @@ public class SimpleGemfireRepository<T, ID extends Serializable> implements Gemf
/*
* (non-Javadoc)
*
*
* @see org.springframework.data.repository.CrudRepository#exists(java.io.Serializable)
*/
@Override
@@ -144,7 +144,7 @@ public class SimpleGemfireRepository<T, ID extends Serializable> implements Gemf
/*
* (non-Javadoc)
*
*
* @see org.springframework.data.repository.CrudRepository#findAll()
*/
@Override
@@ -158,7 +158,7 @@ public class SimpleGemfireRepository<T, ID extends Serializable> implements Gemf
* @see org.springframework.data.gemfire.repository.GemfireRepository.sort(:org.springframework.data.domain.Sort)
*/
@Override
public Iterable<T> findAll(final Sort sort) {
public Iterable<T> findAll(Sort sort) {
QueryString query = new QueryString("SELECT * FROM /RegionPlaceholder")
.forRegion(entityInformation.getJavaType(), template.getRegion())
.orderBy(sort);
@@ -197,7 +197,7 @@ public class SimpleGemfireRepository<T, ID extends Serializable> implements Gemf
/*
* (non-Javadoc)
*
*
* @see
* org.springframework.data.repository.CrudRepository#delete(java.lang.Object)
*/
@@ -208,7 +208,7 @@ public class SimpleGemfireRepository<T, ID extends Serializable> implements Gemf
/*
* (non-Javadoc)
*
*
* @see
* org.springframework.data.repository.CrudRepository#delete(java.lang.Iterable)
*/
@@ -267,7 +267,7 @@ public class SimpleGemfireRepository<T, ID extends Serializable> implements Gemf
/*
* (non-Javadoc)
*
*
* @see org.springframework.data.repository.CrudRepository#deleteAll()
*/
@Override