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.predicate;
015
016import org.gbif.api.model.common.search.SearchParameter;
017
018import javax.annotation.Nullable;
019
020import com.fasterxml.jackson.annotation.JsonCreator;
021import com.fasterxml.jackson.annotation.JsonProperty;
022
023import io.swagger.v3.oas.annotations.media.Schema;
024
025/**
026 * This predicate checks if its {@code key} is LIKE its {@code value}.
027 * The syntax for one <code>?</code> or any <code>*</code> arbitrary matching characters
028 * is the one used by ElasticSearch, Unix/DOS shells, etc.
029 */
030@Schema(
031  description = "This predicate checks if its `key` matches a simple pattern in the `value`.\n\n" +
032    "The character `?` matches a single character, and `*` matches zero or more characters.\n" +
033    "This is similar to the matching used by ElasticSearch, Unix/DOS shells, etc."
034)
035public class LikePredicate<S extends SearchParameter> extends SimplePredicate<S> {
036
037  @JsonCreator
038  public LikePredicate(
039      @JsonProperty("key") S key,
040      @JsonProperty("value") String value,
041      @Nullable @JsonProperty(value = "matchCase") Boolean matchCase) {
042    super(false, key, value, matchCase);
043    // make sure we deal with a String type
044    if (!String.class.equals(key.type())) {
045      throw new IllegalArgumentException("Like comparisons are only allowed for strings but not parameter " + key);
046    }
047  }
048}