Class ComparisonBoolFunction
- java.lang.Object
-
- org.apache.lucene.queries.function.ValueSource
-
- org.apache.lucene.queries.function.valuesource.BoolFunction
-
- org.apache.lucene.queries.function.valuesource.ComparisonBoolFunction
-
public abstract class ComparisonBoolFunction extends BoolFunction
Base class for comparison operators useful within an "if"/conditional.
-
-
Constructor Summary
Constructors Constructor Description ComparisonBoolFunction(ValueSource lhs, ValueSource rhs, String name)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract booleancompare(int doc, FunctionValues lhs, FunctionValues rhs)Perform the comparison, returning true or falsevoidcreateWeight(Map<Object,Object> context, IndexSearcher searcher)Implementations should propagate createWeight to sub-ValueSources which can optionally store weight info in the context.Stringdescription()description of field, used in explain()booleanequals(Object o)FunctionValuesgetValues(Map<Object,Object> context, LeafReaderContext readerContext)Gets the values for this reader and the context that was previously passed to createWeight().inthashCode()Stringname()Uniquely identify the operation (ie "gt", "lt" "gte", etc)-
Methods inherited from class org.apache.lucene.queries.function.ValueSource
asDoubleValuesSource, asLongValuesSource, fromDoubleValuesSource, getSortField, newContext, toString
-
-
-
-
Constructor Detail
-
ComparisonBoolFunction
public ComparisonBoolFunction(ValueSource lhs, ValueSource rhs, String name)
-
-
Method Detail
-
compare
public abstract boolean compare(int doc, FunctionValues lhs, FunctionValues rhs) throws IOExceptionPerform the comparison, returning true or false- Throws:
IOException
-
name
public String name()
Uniquely identify the operation (ie "gt", "lt" "gte", etc)
-
getValues
public FunctionValues getValues(Map<Object,Object> context, LeafReaderContext readerContext) throws IOException
Description copied from class:ValueSourceGets the values for this reader and the context that was previously passed to createWeight(). The values must be consumed in a forward docID manner, and you must call this method again to iterate through the values again.- Specified by:
getValuesin classValueSource- Throws:
IOException
-
equals
public boolean equals(Object o)
- Specified by:
equalsin classValueSource
-
hashCode
public int hashCode()
- Specified by:
hashCodein classValueSource
-
description
public String description()
Description copied from class:ValueSourcedescription of field, used in explain()- Specified by:
descriptionin classValueSource
-
createWeight
public void createWeight(Map<Object,Object> context, IndexSearcher searcher) throws IOException
Description copied from class:ValueSourceImplementations should propagate createWeight to sub-ValueSources which can optionally store weight info in the context. The context object will be passed to getValues() where this info can be retrieved.- Overrides:
createWeightin classValueSource- Throws:
IOException
-
-