Package org.apache.lucene.search
Enum Class BooleanClause.Occur
- All Implemented Interfaces:
Serializable
,Comparable<BooleanClause.Occur>
,Constable
- Enclosing class:
- BooleanClause
Specifies how clauses are to occur in matching documents.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionLikeMUST
except that these clauses do not participate in scoring.Use this operator for clauses that must appear in the matching documents.Use this operator for clauses that must not appear in the matching documents.Use this operator for clauses that should appear in the matching documents. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic BooleanClause.Occur
Returns the enum constant of this class with the specified name.static BooleanClause.Occur[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
MUST
Use this operator for clauses that must appear in the matching documents. -
FILTER
LikeMUST
except that these clauses do not participate in scoring. -
SHOULD
Use this operator for clauses that should appear in the matching documents. For a BooleanQuery with noMUST
clauses one or moreSHOULD
clauses must match a document for the BooleanQuery to match. -
MUST_NOT
Use this operator for clauses that must not appear in the matching documents. Note that it is not possible to search for queries that only consist of aMUST_NOT
clause. These clauses do not contribute to the score of documents.
-
-
Constructor Details
-
Occur
private Occur()
-
-
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
-