org.apache.solr.search.function.distance

Class HaversineFunction

java.lang.Object

org.apache.lucene.queries.function.ValueSource

org.apache.solr.search.function.distance.HaversineFunction

public class HaversineFunction
extends org.apache.lucene.queries.function.ValueSource

Calculate the Haversine formula (distance) between any two points on a sphere Takes in four value sources: (latA, lonA); (latB, lonB).

Assumes the value sources are in radians unless

See http://en.wikipedia.org/wiki/Great-circle_distance and http://en.wikipedia.org/wiki/Haversine_formula for the actual formula and also http://www.movable-type.co.uk/scripts/latlong.html

Constructor Summary

Constructors

Constructor and Description
HaversineFunction(org.apache.lucene.queries.function.valuesource.MultiValueSource p1, org.apache.lucene.queries.function.valuesource.MultiValueSource p2, double radius)
HaversineFunction(org.apache.lucene.queries.function.valuesource.MultiValueSource p1, org.apache.lucene.queries.function.valuesource.MultiValueSource p2, double radius, boolean convertToRads)

Method Summary

Modifier and Type	Method and Description
void	createWeight(Map context, org.apache.lucene.search.IndexSearcher searcher)
String	description()
protected double	distance(int doc, org.apache.lucene.queries.function.FunctionValues p1DV, org.apache.lucene.queries.function.FunctionValues p2DV)
boolean	equals(Object o)
org.apache.lucene.queries.function.FunctionValues	getValues(Map context, org.apache.lucene.index.AtomicReaderContext readerContext)
int	hashCode()
protected String	name()

Methods inherited from class org.apache.lucene.queries.function.ValueSource

getSortField, newContext, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HaversineFunction

public HaversineFunction(org.apache.lucene.queries.function.valuesource.MultiValueSource p1,
                         org.apache.lucene.queries.function.valuesource.MultiValueSource p2,
                         double radius)

HaversineFunction

public HaversineFunction(org.apache.lucene.queries.function.valuesource.MultiValueSource p1,
                         org.apache.lucene.queries.function.valuesource.MultiValueSource p2,
                         double radius,
                         boolean convertToRads)

Method Detail

name

protected String name()

distance

protected double distance(int doc,
                          org.apache.lucene.queries.function.FunctionValues p1DV,
                          org.apache.lucene.queries.function.FunctionValues p2DV)

Parameters:

doc - The doc to score

Returns:

The haversine distance formula

getValues

public org.apache.lucene.queries.function.FunctionValues getValues(Map context,
                                                                   org.apache.lucene.index.AtomicReaderContext readerContext)
                                                            throws IOException

Specified by:

getValues in class org.apache.lucene.queries.function.ValueSource

Throws:

IOException

createWeight

public void createWeight(Map context,
                         org.apache.lucene.search.IndexSearcher searcher)
                  throws IOException

Overrides:

createWeight in class org.apache.lucene.queries.function.ValueSource

Throws:

IOException

equals

public boolean equals(Object o)

Specified by:

equals in class org.apache.lucene.queries.function.ValueSource

hashCode

public int hashCode()

Specified by:

hashCode in class org.apache.lucene.queries.function.ValueSource

description

public String description()

Specified by:

description in class org.apache.lucene.queries.function.ValueSource