Package org.apache.lucene.document

Class XYPointSortField

java.lang.Object

org.apache.lucene.search.SortField

org.apache.lucene.document.XYPointSortField

final class XYPointSortField
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) float	x
(package private) float	y

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

FIELD_DOC, FIELD_SCORE, missingValue, STRING_FIRST, STRING_LAST

Constructor Summary

Constructors

Constructor	Description
XYPointSortField(java.lang.String field, float x, float y)

Method Summary

Modifier and Type	Method	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, getCanUsePoints, getComparatorSource, getField, getIndexSorter, getReverse, getType, needsScores, readType, rewrite, setBytesComparator, setCanUsePoints

Methods inherited from class java.lang.Object

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

Field Detail

x

final float x

y

final float y

Constructor Detail

XYPointSortField

XYPointSortField(java.lang.String field,
                 float x,
                 float y)

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). canUsePoints field is not part of equals and hasCode intentionally, as it is only useful during search-time and using it in these functions prevents index sorting optimizations that rely on the equality of the index-time and search-time SortField instances.

Overrides:

equals in class SortField

toString

public java.lang.String toString()

Overrides:

toString in class SortField