All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.solr.search.SpatialFilterQParserPlugin Maven / Gradle / Ivy

There is a newer version: 9.7.0
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.solr.search;

import org.apache.solr.common.params.SolrParams;
import org.apache.solr.request.SolrQueryRequest;
import org.apache.solr.schema.LatLonPointSpatialField;
import org.apache.solr.schema.PointType;

/**
 * Creates a spatial Filter based on the type of spatial point used.
 *
 * 

The field must implement {@link org.apache.solr.schema.SpatialQueryable} * *

All units are in Kilometers * *

Syntax: * *

{!geofilt sfield=<location_field> pt=<lat,lon> d=<distance>}
* *

Parameters: * *

    *
  • sfield - The field to filter on. Required. *
  • pt - The point to use as a reference. Must match the dimension of the field. Required. *
  • d - The distance in km. Required. *
* * The distance measure used currently depends on the FieldType. {@link LatLonPointSpatialField} * defaults to using haversine, {@link PointType} defaults to Euclidean (2-norm). * *

Examples: * *

fq={!geofilt sfield=store pt=10.312,-20.556 d=3.5}
* *
fq={!geofilt sfield=store}&pt=10.312,-20&d=3.5
* *
fq={!geofilt}&sfield=store&pt=10.312,-20&d=3.5
* *

Note: The geofilt for {@link LatLonPointSpatialField} is capable of also producing scores * equal to the computed distance from the point to the field, making it useful as a component of * the main query or a boosting query. */ public class SpatialFilterQParserPlugin extends QParserPlugin { public static final String NAME = "geofilt"; @Override public QParser createParser( String qstr, SolrParams localParams, SolrParams params, SolrQueryRequest req) { return new SpatialFilterQParser(qstr, localParams, params, req, false); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy