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.
-
-
Field Summary
Fields Modifier and Type Field Description private ValueSource
lhs
private java.lang.String
name
private ValueSource
rhs
-
Constructor Summary
Constructors Constructor Description ComparisonBoolFunction(ValueSource lhs, ValueSource rhs, java.lang.String name)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract boolean
compare(int doc, FunctionValues lhs, FunctionValues rhs)
Perform the comparison, returning true or falsevoid
createWeight(java.util.Map<java.lang.Object,java.lang.Object> context, IndexSearcher searcher)
Implementations should propagate createWeight to sub-ValueSources which can optionally store weight info in the context.java.lang.String
description()
description of field, used in explain()boolean
equals(java.lang.Object o)
FunctionValues
getValues(java.util.Map<java.lang.Object,java.lang.Object> context, LeafReaderContext readerContext)
Gets the values for this reader and the context that was previously passed to createWeight().int
hashCode()
java.lang.String
name()
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
-
-
-
-
Field Detail
-
lhs
private final ValueSource lhs
-
rhs
private final ValueSource rhs
-
name
private final java.lang.String name
-
-
Constructor Detail
-
ComparisonBoolFunction
public ComparisonBoolFunction(ValueSource lhs, ValueSource rhs, java.lang.String name)
-
-
Method Detail
-
compare
public abstract boolean compare(int doc, FunctionValues lhs, FunctionValues rhs) throws java.io.IOException
Perform the comparison, returning true or false- Throws:
java.io.IOException
-
name
public java.lang.String name()
Uniquely identify the operation (ie "gt", "lt" "gte", etc)
-
getValues
public FunctionValues getValues(java.util.Map<java.lang.Object,java.lang.Object> context, LeafReaderContext readerContext) throws java.io.IOException
Description copied from class:ValueSource
Gets 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:
getValues
in classValueSource
- Throws:
java.io.IOException
-
equals
public boolean equals(java.lang.Object o)
- Specified by:
equals
in classValueSource
-
hashCode
public int hashCode()
- Specified by:
hashCode
in classValueSource
-
description
public java.lang.String description()
Description copied from class:ValueSource
description of field, used in explain()- Specified by:
description
in classValueSource
-
createWeight
public void createWeight(java.util.Map<java.lang.Object,java.lang.Object> context, IndexSearcher searcher) throws java.io.IOException
Description copied from class:ValueSource
Implementations 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:
createWeight
in classValueSource
- Throws:
java.io.IOException
-
-