org.springframework.data.jpa.datatables.mapping.DataTablesInput Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-data-jpa-datatables Show documentation
Spring Data JPA extension to work with the great jQuery plug-in DataTables (http://datatables.net/)
There is a newer version: 7.0.1
Show newest version
package org.springframework.data.jpa.datatables.mapping;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.validation.constraints.Min;
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;

public class DataTablesInput {

  /**
   * Draw counter. This is used by DataTables to ensure that the Ajax returns from server-side
   * processing requests are drawn in sequence by DataTables (Ajax requests are asynchronous and
   * thus can return out of sequence). This is used as part of the draw return parameter (see
   * below).
   */
  @NotNull
  @Min(0)
  private Integer draw;

  /**
   * 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;

  /**
   * Number of records that the table can display in the current draw. It is expected that the
   * number of records returned will be equal to this number, unless the server has fewer records to
   * return. Note that this can be -1 to indicate that all records should be returned (although that
   * negates any benefits of server-side processing!)
   */
  @NotNull
  @Min(-1)
  private Integer length;

  /**
   * Global search parameter.
   */
  @NotNull
  private SearchParameter search;

  /**
   * Order parameter
   */
  @NotEmpty
  private List order;

  /**
   * Per-column search parameter
   */
  @NotEmpty
  private List columns;

  public DataTablesInput() {
    this.draw = 1;
    this.start = 0;
    this.length = 10;
    this.search = new SearchParameter();
    this.order = new ArrayList();
    this.columns = new ArrayList();
  }

  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 getOrder() {
    return order;
  }

  public void setOrder(List order) {
    this.order = order;
  }

  public List getColumns() {
    return columns;
  }

  public void setColumns(List columns) {
    this.columns = columns;
  }

  /**
   * 
   * @return a {@link Map} of {@link ColumnParameter} indexed by name
   */
  public Map getColumnsAsMap() {
    Map map = new HashMap();
    for (ColumnParameter column : columns) {
      map.put(column.getData(), column);
    }
    return map;
  }

  /**
   * Find a column by its name
   *
   * @param columnName the name of the column
   * @return the given Column, or null if not found
   */
  public ColumnParameter getColumn(String columnName) {
    if (columnName == null) {
      return null;
    }
    for (ColumnParameter column : columns) {
      if (columnName.equals(column.getData())) {
        return column;
      }
    }
    return null;
  }

  /**
   * Add a new column
   *
   * @param columnName the name of the column
   * @param searchable whether the column is searchable or not
   * @param orderable whether the column is orderable or not
   * @param searchValue if any, the search value to apply
   */
  public void addColumn(String columnName, boolean searchable, boolean orderable,
      String searchValue) {
    this.columns.add(new ColumnParameter(columnName, "", searchable, orderable,
        new SearchParameter(searchValue, false)));
  }

  /**
   * Add an order on the given column
   *
   * @param columnName the name of the column
   * @param ascending whether the sorting is ascending or descending
   */
  public void addOrder(String columnName, boolean ascending) {
    if (columnName == null) {
      return;
    }
    for (int i = 0; i < columns.size(); i++) {
      if (!columnName.equals(columns.get(i).getData())) {
        continue;
      }
      order.add(new OrderParameter(i, ascending ? "asc" : "desc"));
    }
  }

  @Override
  public String toString() {
    return "DataTablesInput [draw=" + draw + ", start=" + start + ", length=" + length + ", search="
        + search + ", order=" + order + ", columns=" + columns + "]";
  }

}