Package org.apache.lucene.search
Enum ScoreMode
- java.lang.Object
-
- java.lang.Enum<ScoreMode>
-
- org.apache.lucene.search.ScoreMode
-
- All Implemented Interfaces:
Serializable
,Comparable<ScoreMode>
public enum ScoreMode extends Enum<ScoreMode>
Different modes of search.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description 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.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract boolean
needsScores()
Whether thisScoreMode
needs to compute scores.static ScoreMode
valueOf(String name)
Returns the enum constant of this type with the specified name.static ScoreMode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
COMPLETE
public static final ScoreMode COMPLETE
Produced scorers will allow visiting all matches and get their score.
-
COMPLETE_NO_SCORES
public static final ScoreMode COMPLETE_NO_SCORES
Produced scorers will allow visiting all matches but scores won't be available.
-
TOP_SCORES
public static final ScoreMode TOP_SCORES
Produced scorers will optionally allow skipping over non-competitive hits using theScorable.setMinCompetitiveScore(float)
API.
-
-
Method Detail
-
values
public static ScoreMode[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (ScoreMode c : ScoreMode.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ScoreMode valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException
- if the argument is null
-
needsScores
public abstract boolean needsScores()
Whether thisScoreMode
needs to compute scores.
-
-