[refactor] update mappings (and reduce boilerplate with lombok) (darrachequesne#35)

Author: darrachequesne

pom.xml

@@ -5,7 +5,7 @@
 
 <groupId>com.github.darrachequesne</groupId>
 <artifactId>spring-data-jpa-datatables</artifactId>
-<version>2.6</version>
+<version>3.0.0-SNAPSHOT</version>
 
 <name>Spring Data JPA for DataTables</name>
 <description>Spring Data JPA extension to work with the great jQuery plug-in DataTables (http://datatables.net/)</description>
@@ -62,6 +62,7 @@
 <maven.compiler.target>${java.version}</maven.compiler.target>
 <source.encoding>UTF-8</source.encoding>
 
+<lombok.version>1.14.8</lombok.version>
 <spring.version>4.2.0.RELEASE</spring.version>
 <spring.data.jpa.version>1.8.2.RELEASE</spring.data.jpa.version>
 <hibernate.version>4.3.11.Final</hibernate.version>
@@ -76,6 +77,12 @@
 </properties>
 
 <dependencies>
+<dependency>
+<groupId>org.projectlombok</groupId>
+<artifactId>lombok</artifactId>
+<version>${lombok.version}</version>
+<scope>provided</scope>
+</dependency>
 
 <dependency>
 <groupId>org.springframework.data</groupId>

src/main/java/org/springframework/data/jpa/datatables/mapping/Column.java

@@ -0,0 +1,62 @@
+package org.springframework.data.jpa.datatables.mapping;
+
+import javax.validation.constraints.NotNull;
+
+import org.hibernate.validator.constraints.NotBlank;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class Column {
+
+ /**
+ * Column's data source
+ * 
+ * @see http://datatables.net/reference/option/columns.data
+ */
+ @NotBlank
+ private String data;
+
+ /**
+ * Column's name
+ * 
+ * @see http://datatables.net/reference/option/columns.name
+ */
+ private String name;
+
+ /**
+ * Flag to indicate if this column is searchable (true) or not (false).
+ * 
+ * @see http://datatables.net/reference/option/columns.searchable
+ */
+ @NotNull
+ private Boolean searchable;
+
+ /**
+ * Flag to indicate if this column is orderable (true) or not (false).
+ * 
+ * @see http://datatables.net/reference/option/columns.orderable
+ */
+ @NotNull
+ private Boolean orderable;
+
+ /**
+ * Search value to apply to this specific column.
+ */
+ @NotNull
+ private Search search;
+
+ /**
+ * Set the search value to apply to this column
+ *
+ * @param searchValue if any, the search value to apply
+ */
+ public void setSearchValue(String searchValue) {
+ this.search.setValue(searchValue);
+ }
+
+}

src/main/java/org/springframework/data/jpa/datatables/mapping/DataTablesInput.java

@@ -9,10 +9,10 @@
 import javax.validation.constraints.NotNull;
 
 import org.hibernate.validator.constraints.NotEmpty;
-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 lombok.Data;
+
+@Data
 public class DataTablesInput {
 
  /**
@@ -23,15 +23,15 @@ public class DataTablesInput {
  */
  @NotNull
  @Min(0)
- private Integer draw;
+ private Integer draw = 1;
 
  /**
  * Paging first record indicator. This is the start point in the current data set (0 index based -
  * i.e. 0 is the first record).
  */
  @NotNull
  @Min(0)
- private Integer start;
+ private Integer start = 0;
 
  /**
  * Number of records that the table can display in the current draw. It is expected that the
@@ -41,90 +41,33 @@ public class DataTablesInput {
  */
  @NotNull
  @Min(-1)
- private Integer length;
+ private Integer length = 10;
 
  /**
  * Global search parameter.
  */
  @NotNull
- private SearchParameter search;
+ private Search search = new Search();
 
  /**
  * Order parameter
  */
  @NotEmpty
- private List<OrderParameter> order;
+ private List<Order> order = new ArrayList<Order>();
 
  /**
  * Per-column search parameter
  */
  @NotEmpty
- private List<ColumnParameter> columns;
-
- public DataTablesInput() {
- this.draw = 1;
- this.start = 0;
- this.length = 10;
- this.search = new SearchParameter();
- this.order = new ArrayList<OrderParameter>();
- this.columns = new ArrayList<ColumnParameter>();
- }
-
- public Integer getDraw() {
- return draw;
- }
-
- public void setDraw(Integer draw) {
- this.draw = draw;
- }
-
- public Integer getStart() {
- return start;
- }
-
- public void setStart(Integer start) {
- this.start = start;
- }
-
- public Integer getLength() {
- return length;
- }
-
- public void setLength(Integer length) {
- this.length = length;
- }
-
- public SearchParameter getSearch() {
- return search;
- }
-
- public void setSearch(SearchParameter search) {
- this.search = search;
- }
-
- public List<OrderParameter> getOrder() {
- return order;
- }
-
- public void setOrder(List<OrderParameter> order) {
- this.order = order;
- }
-
- public List<ColumnParameter> getColumns() {
- return columns;
- }
-
- public void setColumns(List<ColumnParameter> columns) {
- this.columns = columns;
- }
+ private List<Column> columns = new ArrayList<Column>();
 
  /**
  * 
- * @return a {@link Map} of {@link ColumnParameter} indexed by name
+ * @return a {@link Map} of {@link Column} indexed by name
  */
- public Map<String, ColumnParameter> getColumnsAsMap() {
- Map<String, ColumnParameter> map = new HashMap<String, ColumnParameter>();
- for (ColumnParameter column : columns) {
+ public Map<String, Column> getColumnsAsMap() {
+ Map<String, Column> map = new HashMap<String, Column>();
+ for (Column column : columns) {
  map.put(column.getData(), column);
  }
  return map;
@@ -136,11 +79,11 @@ public Map<String, ColumnParameter> getColumnsAsMap() {
  * @param columnName the name of the column
  * @return the given Column, or <code>null</code> if not found
  */
- public ColumnParameter getColumn(String columnName) {
+ public Column getColumn(String columnName) {
  if (columnName == null) {
  return null;
  }
- for (ColumnParameter column : columns) {
+ for (Column column : columns) {
  if (columnName.equals(column.getData())) {
  return column;
  }
@@ -158,8 +101,8 @@ public ColumnParameter getColumn(String columnName) {
  */
  public void addColumn(String columnName, boolean searchable, boolean orderable,
  String searchValue) {
- this.columns.add(new ColumnParameter(columnName, "", searchable, orderable,
- new SearchParameter(searchValue, false)));
+ this.columns.add(new Column(columnName, "", searchable, orderable,
+ new Search(searchValue, false)));
  }
 
  /**
@@ -176,14 +119,8 @@ public void addOrder(String columnName, boolean ascending) {
  if (!columnName.equals(columns.get(i).getData())) {
  continue;
  }
- order.add(new OrderParameter(i, ascending ? "asc" : "desc"));
+ order.add(new Order(i, ascending ? "asc" : "desc"));
  }
  }
 
- @Override
- public String toString() {
- return "DataTablesInput [draw=" + draw + ", start=" + start + ", length=" + length + ", search="
- + search + ", order=" + order + ", columns=" + columns + "]";
- }
-
 }

src/main/java/org/springframework/data/jpa/datatables/mapping/DataTablesOutput.java

@@ -5,6 +5,9 @@
 
 import com.fasterxml.jackson.annotation.JsonView;
 
+import lombok.Data;
+
+@Data
 public class DataTablesOutput<T> {
 
  /**
@@ -48,50 +51,4 @@ public class DataTablesOutput<T> {
  public interface View {
  }
 
- public int getDraw() {
- return draw;
- }
-
- public void setDraw(int draw) {
- this.draw = draw;
- }
-
- public long getRecordsTotal() {
- return recordsTotal;
- }
-
- public void setRecordsTotal(long recordsTotal) {
- this.recordsTotal = recordsTotal;
- }
-
- public long getRecordsFiltered() {
- return recordsFiltered;
- }
-
- public void setRecordsFiltered(long recordsFiltered) {
- this.recordsFiltered = recordsFiltered;
- }
-
- public List<T> getData() {
- return data;
- }
-
- public void setData(List<T> data) {
- this.data = data;
- }
-
- public String getError() {
- return error;
- }
-
- public void setError(String error) {
- this.error = error;
- }
-
- @Override
- public String toString() {
- return "DataTablesOutput [draw=" + draw + ", recordsTotal=" + recordsTotal
- + ", recordsFiltered=" + recordsFiltered + ", error=" + error + "]";
- }
-
 }

src/main/java/org/springframework/data/jpa/datatables/mapping/Order.java

@@ -0,0 +1,32 @@
+package org.springframework.data.jpa.datatables.mapping;
+
+import javax.validation.constraints.Min;
+import javax.validation.constraints.NotNull;
+import javax.validation.constraints.Pattern;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class Order {
+
+ /**
+ * Column to which ordering should be applied. This is an index reference to the columns array of
+ * information that is also submitted to the server.
+ */
+ @NotNull
+ @Min(0)
+ private Integer column;
+
+ /**
+ * Ordering direction for this column. It will be asc or desc to indicate ascending ordering or
+ * descending ordering, respectively.
+ */
+ @NotNull
+ @Pattern(regexp = "(desc|asc)")
+ private String dir;
+
+}

src/main/java/org/springframework/data/jpa/datatables/mapping/Search.java

@@ -0,0 +1,29 @@
+package org.springframework.data.jpa.datatables.mapping;
+
+import javax.validation.constraints.NotNull;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class Search {
+
+ /**
+ * Global search value. To be applied to all columns which have searchable as true.
+ */
+ @NotNull
+ private String value;
+
+ /**
+ * true if the global filter should be treated as a regular expression for advanced searching,
+ * false otherwise. Note that normally server-side processing scripts will not perform regular
+ * expression searching for performance reasons on large data sets, but it is technically possible
+ * and at the discretion of your script.
+ */
+ @NotNull
+ private Boolean regex;
+
+}