DATAJPA-218 - Adopt QBE API refactoring.

Adopt changes from query by example API refactoring.

Related ticket: DATACMNS-810.

Author: mp911de

.gitignore

@@ -1,5 +1,7 @@
 target/
+.idea/
 .settings/
+*.iml
 .project
 .classpath
 .springBeans

src/main/java/org/springframework/data/jpa/convert/QueryByExamplePredicateBuilder.java

@@ -34,7 +34,8 @@
 
 import org.springframework.dao.InvalidDataAccessApiUsageException;
 import org.springframework.data.domain.Example;
-import org.springframework.data.domain.Example.NullHandler;
+import org.springframework.data.domain.ExampleSpec;
+import org.springframework.data.domain.ExampleSpecAccessor;
 import org.springframework.data.util.DirectFieldAccessFallbackBeanWrapper;
 import org.springframework.orm.jpa.JpaSystemException;
 import org.springframework.util.Assert;
@@ -48,8 +49,9 @@
  * The builder includes any {@link SingularAttribute} of the {@link Example#getProbe()} applying {@link String} and
  * {@literal null} matching strategies configured on the {@link Example}. Ignored paths are no matter of their actual
  * value not considered. <br />
- * 
+ *
  * @author Christoph Strobl
+ * @author Mark Paluch
  * @since 1.10
  */
 public class QueryByExamplePredicateBuilder {
@@ -63,7 +65,7 @@ public class QueryByExamplePredicateBuilder {
 
 	/**
 	 * Extract the {@link Predicate} representing the {@link Example}.
-	 * 
+	 *
 	 * @param root must not be {@literal null}.
 	 * @param cb must not be {@literal null}.
 	 * @param example must not be {@literal null}.
@@ -73,10 +75,10 @@ public static <T> Predicate getPredicate(Root<T> root, CriteriaBuilder cb, Examp
 
 		Assert.notNull(root, "Root must not be null!");
 		Assert.notNull(cb, "CriteriaBuilder must not be null!");
-		Assert.notNull(example, "Root must not be null!");
+		Assert.notNull(example, "Example must not be null!");
 
-		List<Predicate> predicates = getPredicates("", cb, root, root.getModel(), example.getSampleObject(), example,
-				new PathNode("root", null, example.getSampleObject()));
+		List<Predicate> predicates = getPredicates("", cb, root, root.getModel(), example.getProbe(),
+				example.getProbeType(), ExampleSpecAccessor.of(example), new PathNode("root", null, example.getProbe()));
 
 		if (predicates.isEmpty()) {
 			return cb.isTrue(cb.literal(false));
@@ -90,8 +92,8 @@ public static <T> Predicate getPredicate(Root<T> root, CriteriaBuilder cb, Examp
 	}
 
 	@SuppressWarnings({ "rawtypes", "unchecked" })
-	static List<Predicate> getPredicates(String path, CriteriaBuilder cb, Path<?> from, ManagedType<?> type,
-			Object value, Example<?> example, PathNode currentNode) {
+	static List<Predicate> getPredicates(String path, CriteriaBuilder cb, Path<?> from, ManagedType<?> type, Object value,
+			Class<?> probeType, ExampleSpecAccessor exampleAccessor, PathNode currentNode) {
 
 		List<Predicate> predicates = new ArrayList<Predicate>();
 		DirectFieldAccessFallbackBeanWrapper beanWrapper = new DirectFieldAccessFallbackBeanWrapper(value);
@@ -100,16 +102,16 @@ static List<Predicate> getPredicates(String path, CriteriaBuilder cb, Path<?> fr
 
 			String currentPath = !StringUtils.hasText(path) ? attribute.getName() : path + "." + attribute.getName();
 
-			if (example.isIgnoredPath(currentPath)) {
+			if (exampleAccessor.isIgnoredPath(currentPath)) {
 				continue;
 			}
 
-			Object attributeValue = example.getValueTransformerForPath(currentPath).convert(
-					beanWrapper.getPropertyValue(attribute.getName()));
+			Object attributeValue = exampleAccessor.getValueTransformerForPath(currentPath)
+					.convert(beanWrapper.getPropertyValue(attribute.getName()));
 
 			if (attributeValue == null) {
 
-				if (example.getNullHandler().equals(NullHandler.INCLUDE)) {
+				if (exampleAccessor.getNullHandler().equals(ExampleSpec.NullHandler.INCLUDE)) {
 					predicates.add(cb.isNull(from.get(attribute)));
 				}
 				continue;
@@ -118,39 +120,39 @@ static List<Predicate> getPredicates(String path, CriteriaBuilder cb, Path<?> fr
 			if (attribute.getPersistentAttributeType().equals(PersistentAttributeType.EMBEDDED)) {
 
 				predicates.addAll(getPredicates(currentPath, cb, from.get(attribute.getName()),
-						(ManagedType<?>) attribute.getType(), attributeValue, example, currentNode));
+						(ManagedType<?>) attribute.getType(), attributeValue, probeType, exampleAccessor, currentNode));
 				continue;
 			}
 
 			if (isAssociation(attribute)) {
 
 				if (!(from instanceof From)) {
-					throw new JpaSystemException(new IllegalArgumentException(String.format(
-							"Unexpected path type for %s. Found % where From.class was expected.", currentPath, from)));
+					throw new JpaSystemException(new IllegalArgumentException(
+							String.format("Unexpected path type for %s. Found % where From.class was expected.", currentPath, from)));
 				}
 
 				PathNode node = currentNode.add(attribute.getName(), attributeValue);
 				if (node.spansCycle()) {
-					throw new InvalidDataAccessApiUsageException(String.format(
-							"Path '%s' from root %s must not span a cyclic property reference!\r\n%s", currentPath,
-							ClassUtils.getShortName(example.getSampleType()), node));
+					throw new InvalidDataAccessApiUsageException(
+							String.format("Path '%s' from root %s must not span a cyclic property reference!\r\n%s", currentPath,
+									ClassUtils.getShortName(probeType), node));
 				}
 
 				predicates.addAll(getPredicates(currentPath, cb, ((From<?, ?>) from).join(attribute.getName()),
-						(ManagedType<?>) attribute.getType(), attributeValue, example, node));
+						(ManagedType<?>) attribute.getType(), attributeValue, probeType, exampleAccessor, node));
 
 				continue;
 			}
 
 			if (attribute.getJavaType().equals(String.class)) {
 
 				Expression<String> expression = from.get(attribute);
-				if (example.isIgnoreCaseForPath(currentPath)) {
+				if (exampleAccessor.isIgnoreCaseForPath(currentPath)) {
 					expression = cb.lower(expression);
 					attributeValue = attributeValue.toString().toLowerCase();
 				}
 
-				switch (example.getStringMatcherForPath(currentPath)) {
+				switch (exampleAccessor.getStringMatcherForPath(currentPath)) {
 
 					case DEFAULT:
 					case EXACT:
@@ -166,8 +168,8 @@ static List<Predicate> getPredicates(String path, CriteriaBuilder cb, Path<?> fr
 						predicates.add(cb.like(expression, "%" + attributeValue));
 						break;
 					default:
-						throw new IllegalArgumentException("Unsupported StringMatcher "
-								+ example.getStringMatcherForPath(currentPath));
+						throw new IllegalArgumentException(
+								"Unsupported StringMatcher " + exampleAccessor.getStringMatcherForPath(currentPath));
 				}
 			} else {
 				predicates.add(cb.equal(from.get(attribute), attributeValue));
@@ -184,7 +186,7 @@ private static boolean isAssociation(Attribute<?, ?> attribute) {
 	/**
 	 * {@link PathNode} is used to dynamically grow a directed graph structure that allows to detect cycles within its
 	 * direct predecessor nodes by comparing parent node values using {@link System#identityHashCode(Object)}.
-	 * 
+	 *
 	 * @author Christoph Strobl
 	 */
 	private static class PathNode {

src/main/java/org/springframework/data/jpa/repository/JpaRepository.java

@@ -21,43 +21,48 @@
 import javax.persistence.EntityManager;
 
 import org.springframework.data.domain.Example;
-import org.springframework.data.domain.Page;
-import org.springframework.data.domain.Pageable;
 import org.springframework.data.domain.Sort;
 import org.springframework.data.repository.NoRepositoryBean;
 import org.springframework.data.repository.PagingAndSortingRepository;
+import org.springframework.data.repository.query.QueryByExampleExecutor;
 
 /**
  * JPA specific extension of {@link org.springframework.data.repository.Repository}.
- * 
+ *
  * @author Oliver Gierke
  * @author Christoph Strobl
+ * @author Mark Paluch
  */
 @NoRepositoryBean
-public interface JpaRepository<T, ID extends Serializable> extends PagingAndSortingRepository<T, ID> {
+public interface JpaRepository<T, ID extends Serializable>
+		extends PagingAndSortingRepository<T, ID>, QueryByExampleExecutor<T> {
 
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.repository.CrudRepository#findAll()
 	 */
+	@Override
 	List<T> findAll();
 
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.repository.PagingAndSortingRepository#findAll(org.springframework.data.domain.Sort)
 	 */
+	@Override
 	List<T> findAll(Sort sort);
 
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.repository.CrudRepository#findAll(java.lang.Iterable)
 	 */
+	@Override
 	List<T> findAll(Iterable<ID> ids);
 
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.repository.CrudRepository#save(java.lang.Iterable)
 	 */
+	@Override
 	<S extends T> List<S> save(Iterable<S> entities);
 
 	/**
@@ -67,7 +72,7 @@ public interface JpaRepository<T, ID extends Serializable> extends PagingAndSort
 
 	/**
 	 * Saves an entity and flushes changes instantly.
-	 * 
+	 *
 	 * @param entity
 	 * @return the saved entity
 	 */
@@ -76,7 +81,7 @@ public interface JpaRepository<T, ID extends Serializable> extends PagingAndSort
 	/**
 	 * Deletes the given entities in a batch which means it will create a single {@link Query}. Assume that we will clear
 	 * the {@link javax.persistence.EntityManager} after the call.
-	 * 
+	 *
 	 * @param entities
 	 */
 	void deleteInBatch(Iterable<T> entities);
@@ -88,40 +93,23 @@ public interface JpaRepository<T, ID extends Serializable> extends PagingAndSort
 
 	/**
 	 * Returns a reference to the entity with the given identifier.
-	 * 
+	 *
 	 * @param id must not be {@literal null}.
 	 * @return a reference to the entity with the given identifier.
 	 * @see EntityManager#getReference(Class, Object)
 	 */
 	T getOne(ID id);
 
-	/**
-	 * Returns all instances of the type specified by the given {@link Example}.
-	 * 
-	 * @param example must not be {@literal null}.
-	 * @return
-	 * @since 1.10
+	/* (non-Javadoc)
+	 * @see org.springframework.data.repository.query.QueryByExampleExecutor#findAll(org.springframework.data.domain.Example)
 	 */
-	List<T> findAllByExample(Example<T> example);
+	@Override
+	<S extends T> List<T> findAll(Example<S> example);
 
-	/**
-	 * Returns all instances of the type specified by the given {@link Example}.
-	 * 
-	 * @param example must not be {@literal null}.
-	 * @param sort can be {@literal null}.
-	 * @return all entities sorted by the given options
-	 * @since 1.10
+	/* (non-Javadoc)
+	 * @see org.springframework.data.repository.query.QueryByExampleExecutor#findAll(org.springframework.data.domain.Example, org.springframework.data.domain.Sort)
 	 */
-	List<T> findAllByExample(Example<T> example, Sort sort);
+	@Override
+	<S extends T> List<T> findAll(Example<S> example, Sort sort);
 
-	/**
-	 * Returns a {@link Page} of entities meeting the paging restriction specified by the given {@link Example} limited to
-	 * criteria provided in the {@code Pageable} object.
-	 * 
-	 * @param example must not be {@literal null}.
-	 * @param pageable can be {@literal null}.
-	 * @return a {@link Page} of entities
-	 * @since 1.10
-	 */
-	Page<T> findAllByExample(Example<T> example, Pageable pageable);
 }