org.apache.solr.search.function.distance

Class GeohashHaversineFunction

java.lang.Object

org.apache.solr.search.function.ValueSource

org.apache.solr.search.function.distance.GeohashHaversineFunction

All Implemented Interfaces:

java.io.Serializable

public class GeohashHaversineFunction
extends ValueSource

Calculate the Haversine distance between two geo hash codes.

Ex: ghhsin(ValueSource, ValueSource, radius)

See Also:

for more details on the implementation, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private ValueSource	geoHash1
private ValueSource	geoHash2
private double	radius

Constructor Summary

Constructors

Constructor and Description
GeohashHaversineFunction(ValueSource geoHash1, ValueSource geoHash2, double radius)

Method Summary

Modifier and Type	Method and Description
void	createWeight(java.util.Map context, org.apache.lucene.search.Searcher searcher) Implementations should propagate createWeight to sub-ValueSources which can optionally store weight info in the context.
java.lang.String	description() description of field, used in explain()
protected double	distance(int doc, DocValues gh1DV, DocValues gh2DV)
boolean	equals(java.lang.Object o)
DocValues	getValues(java.util.Map context, org.apache.lucene.index.IndexReader reader) Gets the values for this reader and the context that was previously passed to createWeight()
int	hashCode()
protected java.lang.String	name()

Methods inherited from class org.apache.solr.search.function.ValueSource

getSortField, getValues, newContext, toString

Methods inherited from class java.lang.Object

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

Field Detail

geoHash1

private ValueSource geoHash1

geoHash2

private ValueSource geoHash2

radius

private double radius

Constructor Detail

GeohashHaversineFunction

public GeohashHaversineFunction(ValueSource geoHash1,
                                ValueSource geoHash2,
                                double radius)

Method Detail

name

protected java.lang.String name()

getValues

public DocValues getValues(java.util.Map context,
                           org.apache.lucene.index.IndexReader reader)
                    throws java.io.IOException

Description copied from class: ValueSource

Gets the values for this reader and the context that was previously passed to createWeight()

Overrides:

getValues in class ValueSource

Throws:

java.io.IOException

distance

protected double distance(int doc,
                          DocValues gh1DV,
                          DocValues gh2DV)

createWeight

public void createWeight(java.util.Map context,
                         org.apache.lucene.search.Searcher searcher)
                  throws java.io.IOException

Description copied from class: ValueSource

Implementations should propagate createWeight to sub-ValueSources which can optionally store weight info in the context. The context object will be passed to getValues() where this info can be retrieved.

Overrides:

createWeight in class ValueSource

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in class ValueSource

hashCode

public int hashCode()

Specified by:

hashCode in class ValueSource

description

public java.lang.String description()

Description copied from class: ValueSource

description of field, used in explain()

Specified by:

description in class ValueSource