org.apache.lucene.spatial.util

Class ShapePredicateValueSource

java.lang.Object

org.apache.lucene.queries.function.ValueSource

org.apache.lucene.spatial.util.ShapePredicateValueSource

public class ShapePredicateValueSource
extends ValueSource

A boolean ValueSource that compares a shape from a provided ValueSource with a given Shape and sees if it matches a given SpatialOperation (the predicate).

Constructor Summary

Constructors

Constructor and Description
ShapePredicateValueSource(ValueSource shapeValuesource, SpatialOperation op, com.spatial4j.core.shape.Shape queryShape)

Method Summary

Modifier and Type	Method and Description
void	createWeight(Map context, IndexSearcher searcher) Implementations should propagate createWeight to sub-ValueSources which can optionally store weight info in the context.
String	description() description of field, used in explain()
boolean	equals(Object o)
FunctionValues	getValues(Map context, LeafReaderContext readerContext) Gets the values for this reader and the context that was previously passed to createWeight()
int	hashCode()

Methods inherited from class org.apache.lucene.queries.function.ValueSource

getSortField, newContext, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ShapePredicateValueSource

public ShapePredicateValueSource(ValueSource shapeValuesource,
                                 SpatialOperation op,
                                 com.spatial4j.core.shape.Shape queryShape)

Parameters:

shapeValuesource - Must yield Shape instances from its objectVal(doc). If null then the result is false. This is the left-hand (indexed) side.

op - the predicate

queryShape - The shape on the right-hand (query) side.

Method Detail

description

public String description()

Description copied from class: ValueSource

description of field, used in explain()

Specified by:

description in class ValueSource

createWeight

public void createWeight(Map context,
                         IndexSearcher searcher)
                  throws 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 class ValueSource

Throws:

IOException

getValues

public FunctionValues getValues(Map context,
                                LeafReaderContext readerContext)
                         throws IOException

Description copied from class: ValueSource

Gets the values for this reader and the context that was previously passed to createWeight()

Specified by:

getValues in class ValueSource

Throws:

IOException

equals

public boolean equals(Object o)

Specified by:

equals in class ValueSource

hashCode

public int hashCode()

Specified by:

hashCode in class ValueSource