Package org.apache.lucene.search
Class PointInSetQuery
java.lang.Object
org.apache.lucene.search.Query
org.apache.lucene.search.PointInSetQuery
- All Implemented Interfaces:
Accountable
Abstract query class to find all documents whose single or multi-dimensional point values,
previously indexed with e.g.
IntPoint, is contained in the specified set.
This is for subclasses and works on the underlying binary encoding: to create range queries
for lucene's standard Point types, refer to factory methods on those classes, e.g. IntPoint.newSetQuery() for fields indexed with IntPoint.
- See Also:
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classIterator of encoded point values. -
Field Summary
FieldsFields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLE -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedPointInSetQuery(String field, int numDims, int bytesPerDim, PointInSetQuery.Stream packedPoints) ThepackedPointsiterator must be in sorted order. -
Method Summary
Modifier and TypeMethodDescriptionfinal WeightcreateWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) Expert: Constructs an appropriate Weight implementation for this query.final booleanOverride and implement query instance equivalence properly in a subclass.intgetField()intCollection<byte[]> final inthashCode()Override and implement query hash code properly in a subclass.longReturn the memory usage of this object in bytes.protected abstract StringtoString(byte[] value) Returns a string of a single value in a human-readable format for debugging.final StringPrints a query to a string, withfieldassumed to be the default field and omitted.voidvisit(QueryVisitor visitor) Recurse through the query tree, visiting any child queries.Methods inherited from class org.apache.lucene.search.Query
classHash, rewrite, sameClassAs, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.lucene.util.Accountable
getChildResources
-
Field Details
-
BASE_RAM_BYTES
protected static final long BASE_RAM_BYTES
-
-
Constructor Details
-
PointInSetQuery
protected PointInSetQuery(String field, int numDims, int bytesPerDim, PointInSetQuery.Stream packedPoints) ThepackedPointsiterator must be in sorted order.
-
-
Method Details
-
visit
Description copied from class:QueryRecurse through the query tree, visiting any child queries. -
createWeight
public final Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException Description copied from class:QueryExpert: Constructs an appropriate Weight implementation for this query.Only implemented by primitive queries, which re-write to themselves.
- Overrides:
createWeightin classQuery- Parameters:
scoreMode- How the produced scorers will be consumed.boost- The boost that is propagated by the parent queries.- Throws:
IOException
-
getPackedPoints
-
getField
-
getNumDims
public int getNumDims() -
getBytesPerDim
public int getBytesPerDim() -
hashCode
public final int hashCode()Description copied from class:QueryOverride and implement query hash code properly in a subclass. This is required so thatQueryCacheworks properly. -
equals
Description copied from class:QueryOverride and implement query instance equivalence properly in a subclass. This is required so thatQueryCacheworks 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 to those of the other instance. Utility methods are provided for certain repetitive code.
-
toString
Description copied from class:QueryPrints a query to a string, withfieldassumed to be the default field and omitted. -
toString
Returns a string of a single value in a human-readable format for debugging. This is used byQuery.toString().The default implementation encodes the individual byte values.
- Parameters:
value- single value, never null- Returns:
- human readable value for debugging
-
ramBytesUsed
public long ramBytesUsed()Description copied from interface:AccountableReturn the memory usage of this object in bytes. Negative values are illegal.- Specified by:
ramBytesUsedin interfaceAccountable
-