Package org.apache.lucene.sandbox.search
Class CoveringQuery
java.lang.Object
org.apache.lucene.search.Query
org.apache.lucene.sandbox.search.CoveringQuery
- All Implemented Interfaces:
Accountable
A
Query
that allows to have a configurable number or required matches per document. This
is typically useful in order to build queries whose query terms must all appear in documents.-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final long
private final int
private final LongValuesSource
private final Collection<Query>
private final long
Fields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLE
-
Constructor Summary
ConstructorsConstructorDescriptionCoveringQuery
(Collection<Query> queries, LongValuesSource minimumNumberMatch) Sole constructor. -
Method Summary
Modifier and TypeMethodDescriptionprivate int
createWeight
(IndexSearcher searcher, ScoreMode scoreMode, float boost) Expert: Constructs an appropriate Weight implementation for this query.boolean
Override and implement query instance equivalence properly in a subclass.int
hashCode()
Override and implement query hash code properly in a subclass.long
Return the memory usage of this object in bytes.rewrite
(IndexReader reader) Expert: called to re-write queries into primitive queries.Prints a query to a string, withfield
assumed to be the default field and omitted.void
visit
(QueryVisitor visitor) Recurse through the query tree, visiting any child queriesMethods inherited from class org.apache.lucene.search.Query
classHash, sameClassAs, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.lucene.util.Accountable
getChildResources
-
Field Details
-
BASE_RAM_BYTES
private static final long BASE_RAM_BYTES -
queries
-
minimumNumberMatch
-
hashCode
private final int hashCode -
ramBytesUsed
private final long ramBytesUsed
-
-
Constructor Details
-
CoveringQuery
Sole constructor.- Parameters:
queries
- Sub queries to match.minimumNumberMatch
- Per-document long value that records how many queries should match. Values that are less than 1 are treated like1
: only documents that have at least one matching clause will be considered matches. Documents that do not have a value forminimumNumberMatch
do not match.
-
-
Method Details
-
toString
Description copied from class:Query
Prints a query to a string, withfield
assumed to be the default field and omitted. -
equals
Description copied from class:Query
Override and implement query instance equivalence properly in a subclass. This is required so thatQueryCache
works properly.Typically a query will be equal to another only if it's an instance of the same class and its document-filtering properties are identical that other instance. Utility methods are provided for certain repetitive code.
-
computeHashCode
private int computeHashCode() -
hashCode
public int hashCode()Description copied from class:Query
Override and implement query hash code properly in a subclass. This is required so thatQueryCache
works properly. -
ramBytesUsed
public long ramBytesUsed()Description copied from interface:Accountable
Return the memory usage of this object in bytes. Negative values are illegal.- Specified by:
ramBytesUsed
in interfaceAccountable
-
rewrite
Description copied from class:Query
Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.Callers are expected to call
rewrite
multiple times if necessary, until the rewritten query is the same as the original query.- Overrides:
rewrite
in classQuery
- Throws:
IOException
- See Also:
-
visit
Description copied from class:Query
Recurse through the query tree, visiting any child queries -
createWeight
public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException Description copied from class:Query
Expert: Constructs an appropriate Weight implementation for this query.Only implemented by primitive queries, which re-write to themselves.
- Overrides:
createWeight
in classQuery
scoreMode
- How the produced scorers will be consumed.boost
- The boost that is propagated by the parent queries.- Throws:
IOException
-