org.sonar.server.es.SearchOptions Maven / Gradle / Ivy
/*
* SonarQube
* Copyright (C) 2009-2018 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.server.es;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.annotation.Nullable;
import org.apache.commons.lang.StringUtils;
import org.sonar.api.server.ws.WebService;
import org.sonar.api.utils.text.JsonWriter;
import static com.google.common.base.Preconditions.checkArgument;
/**
* Various Elasticsearch request options: paging, fields and facets
*/
public class SearchOptions {
public static final int DEFAULT_OFFSET = 0;
public static final int DEFAULT_LIMIT = 10;
public static final int MAX_LIMIT = 500;
private static final int MAX_RETURNABLE_RESULTS = 10_000;
private int offset = DEFAULT_OFFSET;
private int limit = DEFAULT_LIMIT;
private final Set facets = new LinkedHashSet<>();
private final Set fieldsToReturn = new HashSet<>();
/**
* Offset of the first result to return. Defaults to {@link #DEFAULT_OFFSET}
*/
public int getOffset() {
return offset;
}
/**
* Sets the offset of the first result to return (zero-based).
*/
public SearchOptions setOffset(int offset) {
checkArgument(offset >= 0, "Offset must be positive");
this.offset = offset;
return this;
}
/**
* Set offset and limit according to page approach. If pageSize is negative, then
* {@link #MAX_LIMIT} is used.
*/
public SearchOptions setPage(int page, int pageSize) {
checkArgument(page >= 1, "Page must be greater or equal to 1 (got " + page + ")");
int lastResultIndex = page * pageSize;
checkArgument(lastResultIndex <= MAX_RETURNABLE_RESULTS, "Can return only the first %s results. %sth result asked.", MAX_RETURNABLE_RESULTS, lastResultIndex);
setLimit(pageSize);
setOffset((page * this.limit) - this.limit);
return this;
}
public int getPage() {
return limit > 0 ? (int) Math.ceil((double) (offset + 1) / (double) limit) : 0;
}
/**
* Limit on the number of results to return. Defaults to {@link #DEFAULT_LIMIT}.
*/
public int getLimit() {
return limit;
}
/**
* Sets the limit on the number of results to return.
*/
public SearchOptions setLimit(int limit) {
if (limit <= 0) {
this.limit = MAX_LIMIT;
} else {
this.limit = Math.min(limit, MAX_LIMIT);
}
return this;
}
/**
* Lists selected facets.
*/
public Collection getFacets() {
return facets;
}
/**
* Selects facets to return for the domain.
*/
public SearchOptions addFacets(@Nullable Collection f) {
if (f != null) {
this.facets.addAll(f);
}
return this;
}
public SearchOptions addFacets(String... array) {
Collections.addAll(facets, array);
return this;
}
public Set getFields() {
return fieldsToReturn;
}
public SearchOptions addFields(@Nullable Collection c) {
if (c != null) {
for (String s : c) {
if (StringUtils.isNotBlank(s)) {
fieldsToReturn.add(s);
}
}
}
return this;
}
public SearchOptions writeJson(JsonWriter json, long totalHits) {
json.prop("total", totalHits);
json.prop(WebService.Param.PAGE, getPage());
json.prop(WebService.Param.PAGE_SIZE, getLimit());
return this;
}
}