com.yelp.nrtsearch.server.luceneserver.field.properties.GeoQueryable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of server Show documentation

GRPC lucene server using near-real-time replication

There is a newer version: 1.0.0-beta.1

/*
 * Copyright 2020 Yelp Inc.
 *
 * 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 com.yelp.nrtsearch.server.luceneserver.field.properties;

import com.yelp.nrtsearch.server.grpc.GeoBoundingBoxQuery;
import com.yelp.nrtsearch.server.grpc.GeoPolygonQuery;
import com.yelp.nrtsearch.server.grpc.GeoRadiusQuery;
import org.apache.lucene.search.Query;

/**
 * Trait interface for {@link com.yelp.nrtsearch.server.luceneserver.field.FieldDef} types that can
 * be queried by geo-related queries.
 */
public interface GeoQueryable {
  /**
   * Build a geo bounding box query for this field type with the given configuration.
   *
   * @param geoBoundingBoxQuery geo bounding box query configuration
   * @return lucene box query
   */
  Query getGeoBoundingBoxQuery(GeoBoundingBoxQuery geoBoundingBoxQuery);

  /**
   * Build a geo radius query for this field type with the given configuration.
   *
   * @param geoRadiusQuery geo radius query configuration
   * @return
   */
  Query getGeoRadiusQuery(GeoRadiusQuery geoRadiusQuery);

  /**
   * Build a geo polygon query for this field type with the given configuration.
   *
   * @param geoPolygonQuery geo polygon query configuration
   * @return lucene geo polygon query
   */
  Query getGeoPolygonQuery(GeoPolygonQuery geoPolygonQuery);
}