Module org.apache.lucene.spatial3d

Package org.apache.lucene.spatial3d

Class Geo3DPointSortField

java.lang.Object

org.apache.lucene.search.SortField

org.apache.lucene.spatial3d.Geo3DPointSortField

final class Geo3DPointSortField
extends SortField

Sorts by distance from an origin location.

Nested Class Summary

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

SortField.Provider, SortField.Type

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final GeoDistanceShape	distanceShape
(package private) final PlanetModel	planetModel

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

FIELD_DOC, FIELD_SCORE, missingValue, STRING_FIRST, STRING_LAST

Constructor Summary

Constructors

Constructor	Description
Geo3DPointSortField(String field, PlanetModel planetModel, GeoDistanceShape distanceShape)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Returns true if o is equal to this.
FieldComparator<?>	getComparator(int numHits, Pruning pruning)	Returns the FieldComparator to use for sorting.
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(Object missingValue)	Set the value to use for documents that don't have a value.
String	toString()

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

getBytesComparator, getComparatorSource, getField, getIndexSorter, getOptimizeSortWithIndexedData, getOptimizeSortWithPoints, getReverse, getType, needsScores, readType, rewrite, setBytesComparator, setOptimizeSortWithIndexedData, setOptimizeSortWithPoints

Methods inherited from class java.lang.Object

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

Field Details

distanceShape

final GeoDistanceShape distanceShape

planetModel

final PlanetModel planetModel

Constructor Details

Geo3DPointSortField

Geo3DPointSortField(String field,
 PlanetModel planetModel,
 GeoDistanceShape distanceShape)

Method Details

getComparator

public FieldComparator<?> getComparator(int numHits,
 Pruning pruning)

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

pruning - controls how can the comparator to skip documents via LeafFieldComparator.competitiveIterator()

Returns:

FieldComparator to use when sorting

getMissingValue

public 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(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(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 String toString()

Overrides:

toString in class SortField