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.occurrence;
015
016import com.fasterxml.jackson.databind.JsonNode;
017
018import io.swagger.v3.oas.annotations.ExternalDocumentation;
019
020import io.swagger.v3.oas.annotations.media.ArraySchema;
021
022import org.gbif.api.model.predicate.ConjunctionPredicate;
023import org.gbif.api.model.predicate.DisjunctionPredicate;
024import org.gbif.api.model.predicate.EqualsPredicate;
025import org.gbif.api.model.predicate.GeoDistancePredicate;
026import org.gbif.api.model.predicate.GreaterThanOrEqualsPredicate;
027import org.gbif.api.model.predicate.GreaterThanPredicate;
028import org.gbif.api.model.predicate.InPredicate;
029import org.gbif.api.model.predicate.IsNotNullPredicate;
030import org.gbif.api.model.predicate.IsNullPredicate;
031import org.gbif.api.model.predicate.LessThanOrEqualsPredicate;
032import org.gbif.api.model.predicate.LessThanPredicate;
033import org.gbif.api.model.predicate.LikePredicate;
034import org.gbif.api.model.predicate.NotPredicate;
035import org.gbif.api.model.predicate.Predicate;
036import org.gbif.api.model.predicate.WithinPredicate;
037import org.gbif.api.vocabulary.Extension;
038
039import java.util.Collection;
040import java.util.Collections;
041import java.util.Objects;
042import java.util.Set;
043import java.util.StringJoiner;
044
045import javax.annotation.Nullable;
046import javax.validation.Valid;
047
048import com.fasterxml.jackson.annotation.JsonCreator;
049import com.fasterxml.jackson.annotation.JsonProperty;
050
051import io.swagger.v3.oas.annotations.media.Schema;
052
053/**
054 * An occurrence download request whose filters are based on predicates ( see {@link Predicate}).
055 */
056@Schema(
057  description = "An occurrence download request whose filters are based on predicates."
058)
059public class PredicateDownloadRequest extends DownloadRequest {
060
061  //Default download format.
062  private static final DownloadFormat DEFAULT_DOWNLOAD_FORMAT = DownloadFormat.SIMPLE_CSV;
063
064  @Schema(
065    description = "A predicate defining the filters to apply to the download.",
066    externalDocs = @ExternalDocumentation(url = "https://techdocs.gbif.org/en/data-use/api-downloads#predicates"),
067    oneOf = {
068      ConjunctionPredicate.class,
069      DisjunctionPredicate.class,
070      EqualsPredicate.class,
071      GeoDistancePredicate.class,
072      GreaterThanOrEqualsPredicate.class,
073      GreaterThanPredicate.class,
074      InPredicate.class,
075      IsNotNullPredicate.class,
076      IsNullPredicate.class,
077      LessThanOrEqualsPredicate.class,
078      LessThanPredicate.class,
079      LikePredicate.class,
080      NotPredicate.class,
081      WithinPredicate.class
082    }
083  )
084  private Predicate predicate;
085
086  @ArraySchema(
087    schema = @Schema(
088      description = "A verbatim (unprocessed) extension to include on a Darwin Core Archive download."
089    )
090  )
091  @JsonProperty("verbatimExtensions")
092  private Set<Extension> verbatimExtensions;
093
094  public PredicateDownloadRequest() {
095
096  }
097
098  /**
099   * Full constructor. Used to create instances using JSON serialization.
100   */
101  @JsonCreator
102  public PredicateDownloadRequest(
103    @JsonProperty("predicate") Predicate predicate,
104    @JsonProperty("creator") @Nullable String creator,
105    @JsonProperty("notificationAddresses") @Nullable Collection<String> notificationAddresses,
106    @JsonProperty("sendNotification") @Nullable Boolean sendNotification,
107    @JsonProperty("format") @Nullable DownloadFormat format,
108    @JsonProperty("type") @Nullable DownloadType type,
109    @JsonProperty("description") @Nullable String description,
110    @JsonProperty("machineDescription") @Nullable JsonNode machineDescription,
111    @JsonProperty("verbatimExtensions") @Nullable Set<Extension> verbatimExtensions) {
112    super(
113      creator,
114      notificationAddresses,
115      sendNotification == null ? Boolean.TRUE : sendNotification,
116      format == null ? DEFAULT_DOWNLOAD_FORMAT : format,
117      type == null ? DownloadType.OCCURRENCE : type,
118      description,
119      machineDescription
120    );
121    this.predicate = predicate;
122    this.verbatimExtensions = verbatimExtensions == null? Collections.emptySet(): verbatimExtensions;
123  }
124
125  /**
126   * @return the download filter
127   */
128  @Nullable
129  @Valid
130  public Predicate getPredicate() {
131    return predicate;
132  }
133
134  public void setPredicate(Predicate predicate) {
135    this.predicate = predicate;
136  }
137
138  /**
139   * Requested verbatimExtensions for this download.
140   */
141  @Nullable
142  public Set<Extension> getVerbatimExtensions() {
143    return verbatimExtensions;
144  }
145
146  public void setVerbatimExtensions(Set<Extension> verbatimExtensions) {
147    this.verbatimExtensions = verbatimExtensions;
148  }
149
150  @Override
151  public boolean equals(Object o) {
152    if (this == o) {
153      return true;
154    }
155    if (o == null || getClass() != o.getClass()) {
156      return false;
157    }
158    if (!super.equals(o)) {
159      return false;
160    }
161    PredicateDownloadRequest that = (PredicateDownloadRequest) o;
162    return Objects.equals(predicate, that.predicate) &&
163      Objects.equals(verbatimExtensions, that.verbatimExtensions);
164  }
165
166  @Override
167  public int hashCode() {
168    return Objects.hash(super.hashCode(), predicate, verbatimExtensions);
169  }
170
171  @Override
172  public String toString() {
173    return new StringJoiner(", ", PredicateDownloadRequest.class.getSimpleName() + "[", "]")
174      .add("predicate=" + predicate)
175      .add("creator='" + getCreator() + "'")
176      .add("notificationAddresses=" + getNotificationAddresses())
177      .add("sendNotification=" + getSendNotification())
178      .add("format=" + getFormat())
179      .add("type=" + getType())
180      .add("verbatimExtensions=" + verbatimExtensions)
181      .toString();
182  }
183}