IFullTextFilter.java

/*
 * Copyright 2020 Global Crop Diversity Trust
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.gringlobal.service.filter;

import org.apache.commons.lang3.StringUtils;

import com.fasterxml.jackson.annotation.JsonIgnore;

/**
 * IFullTextFilter is used to mark filters that use full-text search with ES
 */
public interface IFullTextFilter {

	/**
	 * Gets the text.
	 *
	 * @return the text
	 */
	String get_text();

	/**
	 * Does the filter require full-text search?
	 *
	 * @return true if {@link #get_text()} is non-blank
	 */
	@JsonIgnore
	default boolean isFulltextQuery() {
		return StringUtils.isNotBlank(get_text());
	}
}