org.apache.lucene.document

Class LatLonPointSortField

java.lang.Object

org.apache.lucene.search.SortField

org.apache.lucene.document.LatLonPointSortField

final class LatLonPointSortField
extends SortField

Sorts by distance from an origin location.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.search.SortField

SortField.Type

Field Summary

Fields

Modifier and Type	Field and Description
(package private) double	latitude
(package private) double	longitude

Fields inherited from class org.apache.lucene.search.SortField

FIELD_DOC, FIELD_SCORE, missingValue, STRING_FIRST, STRING_LAST

Constructor Summary

Constructors

Constructor and Description
LatLonPointSortField(java.lang.String field, double latitude, double longitude)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Returns true if o is equal to this.
FieldComparator<?>	getComparator(int numHits, int sortPos) Returns the FieldComparator to use for sorting.
java.lang.Double	getMissingValue() Return the value to use for documents that don't have a value.
int	hashCode() Returns a hash code for this SortField instance.
void	setMissingValue(java.lang.Object missingValue) Set the value to use for documents that don't have a value.
java.lang.String	toString()

Methods inherited from class org.apache.lucene.search.SortField

getBytesComparator, getComparatorSource, getField, getReverse, getType, needsScores, rewrite, setBytesComparator

Methods inherited from class java.lang.Object

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

Field Detail

latitude

final double latitude

longitude

final double longitude

Constructor Detail

LatLonPointSortField

LatLonPointSortField(java.lang.String field,
                     double latitude,
                     double longitude)

Method Detail

getComparator

public FieldComparator<?> getComparator(int numHits,
                                        int sortPos)

Description copied from class: SortField

Returns the FieldComparator to use for sorting.

Overrides:

getComparator in class SortField

Parameters:

numHits - number of top hits the queue will store

sortPos - position of this SortField within Sort. The comparator is primary if sortPos==0, secondary if sortPos==1, etc. Some comparators can optimize themselves when they are the primary sort.

Returns:

FieldComparator to use when sorting

getMissingValue

public java.lang.Double getMissingValue()

Description copied from class: SortField

Return the value to use for documents that don't have a value. A value of null indicates that default should be used.

Overrides:

getMissingValue in class SortField

setMissingValue

public void setMissingValue(java.lang.Object missingValue)

Description copied from class: SortField

Set the value to use for documents that don't have a value.

Overrides:

setMissingValue in class SortField

hashCode

public int hashCode()

Description copied from class: SortField

Returns a hash code for this SortField instance. If a FieldComparatorSource was provided, it must properly implement hashCode (unless a singleton is always used).

Overrides:

hashCode in class SortField

equals

public boolean equals(java.lang.Object obj)

Description copied from class: SortField

Returns true if o is equal to this. If a FieldComparatorSource was provided, it must properly implement equals (unless a singleton is always used).

Overrides:

equals in class SortField

toString

public java.lang.String toString()

Overrides:

toString in class SortField