Package org.apache.lucene.search
Enum Class ScoreMode
- All Implemented Interfaces:
Serializable,Comparable<ScoreMode>,Constable
Different modes of search.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionProduced scorers will allow visiting all matches and get their score.Produced scorers will allow visiting all matches but scores won't be available.ScoreMode for top field collectors that can provide their own iterators, to optionally allow to skip for non-competitive docsScoreMode for top field collectors that can provide their own iterators, to optionally allow to skip for non-competitive docs.Produced scorers will optionally allow skipping over non-competitive hits using theScorable.setMinCompetitiveScore(float)API. -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturnstrueif for thisScoreModeit is necessary to process all documents, orfalseif is enough to go through top documents only.booleanWhether thisScoreModeneeds to compute scores.static ScoreModeReturns the enum constant of this class with the specified name.static ScoreMode[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
COMPLETE
Produced scorers will allow visiting all matches and get their score. -
COMPLETE_NO_SCORES
Produced scorers will allow visiting all matches but scores won't be available. -
TOP_SCORES
Produced scorers will optionally allow skipping over non-competitive hits using theScorable.setMinCompetitiveScore(float)API. -
TOP_DOCS
ScoreMode for top field collectors that can provide their own iterators, to optionally allow to skip for non-competitive docs -
TOP_DOCS_WITH_SCORES
ScoreMode for top field collectors that can provide their own iterators, to optionally allow to skip for non-competitive docs. This mode is used when there is a secondary sort by _score.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-
needsScores
public boolean needsScores()Whether thisScoreModeneeds to compute scores. -
isExhaustive
public boolean isExhaustive()Returnstrueif for thisScoreModeit is necessary to process all documents, orfalseif is enough to go through top documents only.
-