Module org.apache.lucene.core

Package org.apache.lucene.document

Class FeatureSortField

java.lang.Object

org.apache.lucene.search.SortField

org.apache.lucene.document.FeatureSortField

final class FeatureSortField
extends SortField

Sorts using the value of a specified feature name from a FeatureField.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	FeatureSortField.FeatureComparator	Parses a feature field's values as float and sorts by descending value

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

SortField.Provider, SortField.Type

Field Summary

Fields

Modifier and Type	Field	Description
private final String	featureName

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

FIELD_DOC, FIELD_SCORE, missingValue, STRING_FIRST, STRING_LAST

Constructor Summary

Constructors

Constructor	Description
FeatureSortField(String field, String featureName)	Creates a FeatureSortField that can be used to sort hits by the value of a particular feature in a FeatureField.

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.
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, getMissingValue, 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

featureName

private final String featureName

Constructor Details

FeatureSortField

public FeatureSortField(String field,
 String featureName)

Creates a FeatureSortField that can be used to sort hits by the value of a particular feature in a FeatureField.

Parameters:

featureName - The name of the feature to use for the sort value

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

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