Module org.apache.lucene.core

Package org.apache.lucene.search

Class DoubleValuesSource.DoubleValuesSortField

java.lang.Object

org.apache.lucene.search.SortField

org.apache.lucene.search.DoubleValuesSource.DoubleValuesSortField

Enclosing class:

DoubleValuesSource

private static class DoubleValuesSource.DoubleValuesSortField
extends SortField

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 DoubleValuesSource	producer

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

FIELD_DOC, FIELD_SCORE, missingValue, reverse, STRING_FIRST, STRING_LAST

Constructor Summary

Constructors

Constructor	Description
DoubleValuesSortField(DoubleValuesSource producer, boolean reverse)

Method Summary

Modifier and Type	Method	Description
boolean	needsScores()	Whether the relevance score is needed to sort documents.
SortField	rewrite(IndexSearcher searcher)	Rewrites this SortField, returning a new SortField if a change is made.
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

equals, getBytesComparator, getComparator, getComparatorSource, getField, getIndexSorter, getMissingValue, getOptimizeSortWithIndexedData, getOptimizeSortWithPoints, getReverse, getType, hashCode, readType, setBytesComparator, setOptimizeSortWithIndexedData, setOptimizeSortWithPoints

Methods inherited from class java.lang.Object

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

Field Details

producer

final DoubleValuesSource producer

Constructor Details

DoubleValuesSortField

DoubleValuesSortField(DoubleValuesSource producer,
 boolean reverse)

Method Details

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

needsScores

public boolean needsScores()

Description copied from class: SortField

Whether the relevance score is needed to sort documents.

Overrides:

needsScores in class SortField

toString

public String toString()

Overrides:

toString in class SortField

rewrite

public SortField rewrite(IndexSearcher searcher)
                  throws IOException

Description copied from class: SortField

Rewrites this SortField, returning a new SortField if a change is made. Subclasses should override this define their rewriting behavior when this SortField is of type SortField.Type.REWRITEABLE

Overrides:

rewrite in class SortField

Parameters:

searcher - IndexSearcher to use during rewriting

Returns:

New rewritten SortField, or this if nothing has changed.

Throws:

IOException - Can be thrown by the rewriting