QueryInfoJsonResult.java

/**
 * diqube: Distributed Query Base.
 *
 * Copyright (C) 2015 Bastian Gloeckle
 *
 * This file is part of diqube.
 *
 * diqube is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.diqube.ui.websocket.result.analysis;

import org.diqube.build.mojo.TypeScriptProperty;
import org.diqube.ui.analysis.UiQuery;
import org.diqube.ui.websocket.result.JsonResult;
import org.diqube.ui.websocket.result.JsonResultDataType;

import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * Result containing information about the "ORDER BY" of a specific {@link UiQuery}.
 *
 * @author Bastian Gloeckle
 */
@JsonResultDataType(QueryInfoJsonResult.TYPE)
public class QueryInfoJsonResult implements JsonResult {
  @TypeScriptProperty
  public static final String TYPE = "queryInfo";

  @JsonProperty
  @TypeScriptProperty
  private String queryId;

  @JsonProperty
  @TypeScriptProperty
  private String finalQueryString;

  @JsonProperty
  @TypeScriptProperty
  private boolean isOrderedBySingleField;

  /** only valid if {@link #isOrderedBySingleField} == true */
  @JsonProperty
  @TypeScriptProperty
  private String orderedByColumnName;

  /** only valid if {@link #isOrderedBySingleField} == true */
  @JsonProperty
  @TypeScriptProperty
  private boolean orderedAsc;

  // for tests only
  public QueryInfoJsonResult() {

  }

  public QueryInfoJsonResult(String queryId, String finalQueryString, boolean isOrderedBySingleField,
      String orderedByColumnName, boolean orderedAsc) {
    this.queryId = queryId;
    this.finalQueryString = finalQueryString;
    this.isOrderedBySingleField = isOrderedBySingleField;
    this.orderedByColumnName = orderedByColumnName;
    this.orderedAsc = orderedAsc;
  }

  public String getFinalQueryString() {
    return finalQueryString;
  }
}