001/*
002 * Licensed under the Apache License, Version 2.0 (the "License");
003 * you may not use this file except in compliance with the License.
004 * You may obtain a copy of the License at
005 *
006 *     http://www.apache.org/licenses/LICENSE-2.0
007 *
008 * Unless required by applicable law or agreed to in writing, software
009 * distributed under the License is distributed on an "AS IS" BASIS,
010 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
011 * See the License for the specific language governing permissions and
012 * limitations under the License.
013 */
014package org.gbif.api.model.collections.request;
015
016import java.util.HashMap;
017import java.util.HashSet;
018import java.util.Map;
019import java.util.Set;
020import javax.annotation.Nullable;
021import lombok.Builder;
022import lombok.Data;
023import lombok.EqualsAndHashCode;
024import lombok.experimental.SuperBuilder;
025import org.gbif.api.model.common.paging.Pageable;
026import org.gbif.api.vocabulary.collections.InstitutionFacetParameter;
027
028@EqualsAndHashCode(callSuper = true)
029@SuperBuilder
030@Data
031public class InstitutionFacetedSearchRequest extends InstitutionSearchRequest
032    implements FacetedSearchRequest<InstitutionFacetParameter> {
033
034  @Builder.Default @Nullable private Set<InstitutionFacetParameter> facets = new HashSet<>();
035  @Nullable private boolean multiSelectFacets;
036  @Nullable private Integer facetMinCount;
037  @Nullable private Integer facetLimit = 10;
038  @Nullable private Integer facetOffset;
039
040  // Holds the paging configuration for each requested facet
041  @Builder.Default @Nullable
042  private Map<InstitutionFacetParameter, Pageable> facetPages = new HashMap<>();
043}