Package org.apache.lucene.document
Class RangeFieldQuery
- java.lang.Object
-
- org.apache.lucene.search.Query
-
- org.apache.lucene.document.RangeFieldQuery
-
public abstract class RangeFieldQuery extends Query
Query class for searchingRangeFieldtypes by a definedPointValues.Relation.- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classRangeFieldQuery.QueryTypeUsed byRangeFieldQueryto check how each internal or leaf node relates to the query.
-
Constructor Summary
Constructors Modifier Constructor Description protectedRangeFieldQuery(String field, byte[] ranges, int numDims, RangeFieldQuery.QueryType queryType)Create a query for searching indexed ranges that match the provided relation.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description WeightcreateWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)Expert: Constructs an appropriate Weight implementation for this query.booleanequals(Object o)Override and implement query instance equivalence properly in a subclass.protected booleanequalsTo(RangeFieldQuery other)Check equality of two RangeFieldQuery objectsinthashCode()Override and implement query hash code properly in a subclass.protected abstract StringtoString(byte[] ranges, int dimension)Returns a string of a single value in a human-readable format for debugging.StringtoString(String field)Prints 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.
-
-
-
Constructor Detail
-
RangeFieldQuery
protected RangeFieldQuery(String field, byte[] ranges, int numDims, RangeFieldQuery.QueryType queryType)
Create a query for searching indexed ranges that match the provided relation.- Parameters:
field- field name. must not be null.ranges- encoded range values; this is done by theRangeFieldimplementationqueryType- the query relation
-
-
Method Detail
-
visit
public void visit(QueryVisitor visitor)
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 classQueryscoreMode- How the produced scorers will be consumed.boost- The boost that is propagated by the parent queries.- Throws:
IOException
-
hashCode
public int hashCode()
Description copied from class:QueryOverride and implement query hash code properly in a subclass. This is required so thatQueryCacheworks properly.- Specified by:
hashCodein classQuery- See Also:
Query.equals(Object)
-
equals
public final boolean equals(Object o)
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.
- Specified by:
equalsin classQuery- See Also:
Query.sameClassAs(Object),Query.classHash()
-
equalsTo
protected boolean equalsTo(RangeFieldQuery other)
Check equality of two RangeFieldQuery objects
-
toString
public String toString(String field)
Description copied from class:QueryPrints a query to a string, withfieldassumed to be the default field and omitted.
-
toString
protected abstract String toString(byte[] ranges, int dimension)
Returns a string of a single value in a human-readable format for debugging. This is used byQuery.toString().- Parameters:
dimension- dimension of the particular valueranges- encoded ranges, never null- Returns:
- human readable value for debugging
-
-