Add an optional pre-filtering specification

Author: darrachequesne

README.md

@@ -90,6 +90,7 @@ It overrides jQuery data serialization to allow Spring MVC to correctly map inpu
 The repositories now expose the following methods:
 * `DataTablesOutput<T> findAll(DataTablesInput input);`
 * `DataTablesOutput<T> findAll(DataTablesInput input, Specification<T> additionalSpecification);`
+* `DataTablesOutput<T> findAll(DataTablesInput input, Specification<T> additionalSpecification, Specification<T> preFilteringSpecification);`
 
 Note: since version 2.0, QueryDSL is also supported:
 * replace `DataTablesRepositoryFactoryBean` with `QDataTablesRepositoryFactoryBean`
@@ -99,6 +100,7 @@ and your repositories will now expose:
 
 * `DataTablesOutput<T> findAll(DataTablesInput input);`
 * `DataTablesOutput<T> findAll(DataTablesInput input, com.mysema.querydsl.Predicate additionalPredicate);`
+* `DataTablesOutput<T> findAll(DataTablesInput input, com.mysema.querydsl.Predicate additionalPredicate, com.mysema.querydsl.Predicate preFilteringPredicate);`
 
 Your controllers should be able to handle the parameters sent by DataTables:
 
@@ -124,6 +126,13 @@ public class UserRestController {
 parameter0.getSearch().setValue("");
 return userRepository.findAll(input, additionalSpecification);
 }
+
+// or with an additional filter allowing to 'hide' data from the client (the filter will be applied on both the count and the data queries, and may impact the recordsTotal in the output)
+@JsonView(DataTablesOutput.View.class)
+@RequestMapping(value = "/data/users", method = RequestMethod.GET)
+public DataTablesOutput<User> getUsers(@Valid DataTablesInput input) {
+return userRepository.findAll(input, null, removeHiddenEntitiesSpecification);
+}
 }
 ```
 

src/main/java/org/springframework/data/jpa/datatables/qrepository/QDataTablesRepository.java

@@ -38,4 +38,17 @@ public interface QDataTablesRepository<T, ID extends Serializable>
  */
  DataTablesOutput<T> findAll(DataTablesInput input, Predicate additionalPredicate);
 
+ /**
+ * Returns the filtered list for the given {@link DataTablesInput}.
+ * 
+ * @param input the {@link DataTablesInput} mapped from the Ajax request
+ * @param additionalPredicate an additional {@link Predicate} to apply to the query (with an "AND"
+ * clause)
+ * @param preFilteringPredicate a pre-filtering {@link Predicate} to apply to the query (with an
+ * "AND" clause)
+ * @return a {@link DataTablesOutput}
+ */
+ DataTablesOutput<T> findAll(DataTablesInput input, Predicate additionalPredicate,
+ Predicate preFilteringPredicate);
+
 }

src/main/java/org/springframework/data/jpa/datatables/qrepository/QDataTablesRepositoryImpl.java

@@ -48,18 +48,25 @@ public QDataTablesRepositoryImpl(JpaEntityInformation<T, ID> entityInformation,
 
  @Override
  public DataTablesOutput<T> findAll(DataTablesInput input) {
- return findAll(input, null);
+ return findAll(input, null, null);
  }
 
  @Override
  public DataTablesOutput<T> findAll(DataTablesInput input, Predicate additionalPredicate) {
+ return findAll(input, additionalPredicate, null);
+ }
+
+ @Override
+ public DataTablesOutput<T> findAll(DataTablesInput input, Predicate additionalPredicate,
+ Predicate preFilteringPredicate) {
  DataTablesOutput<T> output = new DataTablesOutput<T>();
  output.setDraw(input.getDraw());
  try {
- output.setRecordsTotal(count());
+ output
+ .setRecordsTotal(preFilteringPredicate == null ? count() : count(preFilteringPredicate));
 
  Page<T> data = findAll(new BooleanBuilder().and(getPredicate(this.builder, input))
- .and(additionalPredicate).getValue(), getPageable(input));
+ .and(additionalPredicate).and(preFilteringPredicate).getValue(), getPageable(input));
 
  output.setData(data.getContent());
  output.setRecordsFiltered(data.getTotalElements());

src/main/java/org/springframework/data/jpa/datatables/repository/DataTablesRepository.java

@@ -37,4 +37,17 @@ public interface DataTablesRepository<T, ID extends Serializable>
  */
  DataTablesOutput<T> findAll(DataTablesInput input, Specification<T> additionalSpecification);
 
+ /**
+ * Returns the filtered list for the given {@link DataTablesInput}.
+ * 
+ * @param input the {@link DataTablesInput} mapped from the Ajax request
+ * @param additionalSpecification an additional {@link Specification} to apply to the query (with
+ * an "AND" clause)
+ * @param preFilteringSpecification a pre-filtering {@link Specification} to apply to the query
+ * (with an "AND" clause)
+ * @return a {@link DataTablesOutput}
+ */
+ DataTablesOutput<T> findAll(DataTablesInput input, Specification<T> additionalSpecification,
+ Specification<T> preFilteringSpecification);
+
 }

src/main/java/org/springframework/data/jpa/datatables/repository/DataTablesRepositoryImpl.java

@@ -31,20 +31,27 @@ public DataTablesRepositoryImpl(JpaEntityInformation<T, ?> entityInformation,
 
  @Override
  public DataTablesOutput<T> findAll(DataTablesInput input) {
- return findAll(input, null);
+ return findAll(input, null, null);
  }
 
  @Override
  public DataTablesOutput<T> findAll(DataTablesInput input,
  Specification<T> additionalSpecification) {
+ return findAll(input, additionalSpecification, null);
+ }
+
+ @Override
+ public DataTablesOutput<T> findAll(DataTablesInput input,
+ Specification<T> additionalSpecification, Specification<T> preFilteringSpecification) {
  DataTablesOutput<T> output = new DataTablesOutput<T>();
  output.setDraw(input.getDraw());
 
  try {
- output.setRecordsTotal(count());
+ output.setRecordsTotal(
+ preFilteringSpecification == null ? count() : count(preFilteringSpecification));
 
  Page<T> data = findAll(Specifications.where(getSpecification(getDomainClass(), input))
- .and(additionalSpecification), getPageable(input));
+ .and(additionalSpecification).and(preFilteringSpecification), getPageable(input));
 
  output.setData(data.getContent());
  output.setRecordsFiltered(data.getTotalElements());
@@ -56,4 +63,5 @@ public DataTablesOutput<T> findAll(DataTablesInput input,
 
  return output;
  }
+
 }

src/test/java/org/springframework/data/jpa/datatables/repository/BillRepositoryTest.java

@@ -17,6 +17,7 @@
 import org.springframework.data.jpa.datatables.parameter.ColumnParameter;
 import org.springframework.data.jpa.datatables.parameter.OrderParameter;
 import org.springframework.data.jpa.datatables.parameter.SearchParameter;
+import org.springframework.data.jpa.datatables.specification.PreFilteringSpecification;
 import org.springframework.test.context.ContextConfiguration;
 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
 
@@ -97,6 +98,17 @@ public void testEscapeCharacter() {
  assertEquals(1, (long) output.getRecordsFiltered());
  }
 
+ @Test
+ public void testWithPreFiltering() {
+ DataTablesInput input = getBasicInput();
+
+ DataTablesOutput<Bill> output =
+ billRepository.findAll(input, null, new PreFilteringSpecification<Bill>());
+ assertNotNull(output);
+ assertEquals(6, (long) output.getRecordsFiltered());
+ assertEquals(6, (long) output.getRecordsTotal());
+ }
+
  /**
  * 
  * @return basic input parameters

src/test/java/org/springframework/data/jpa/datatables/specification/PreFilteringSpecification.java

@@ -0,0 +1,18 @@
+package org.springframework.data.jpa.datatables.specification;
+
+import javax.persistence.criteria.CriteriaBuilder;
+import javax.persistence.criteria.CriteriaQuery;
+import javax.persistence.criteria.Predicate;
+import javax.persistence.criteria.Root;
+
+import org.springframework.data.jpa.domain.Specification;
+
+public class PreFilteringSpecification<T> implements Specification<T> {
+
+ @Override
+ public Predicate toPredicate(Root<T> root, CriteriaQuery<?> query,
+ CriteriaBuilder criteriaBuilder) {
+ return criteriaBuilder.le(root.get("id").as(Integer.class), 6);
+ }
+
+}