Class ShapePredicateValueSource

A boolean Lucene.Net.Queries.Function.ValueSource that compares a shape from a provided Lucene.Net.Queries.Function.ValueSource with a given Spatial4n.Shapes.IShape and sees if it matches a given SpatialOperation (the predicate).

Note

This API is experimental and might change in incompatible ways in the next release.

Inheritance
object
ValueSource
ShapePredicateValueSource
Inherited Members
ValueSource.ToString()
ValueSource.NewContext(IndexSearcher)
Namespace: Lucene.Net.Spatial.Util
Assembly: Lucene.Net.Spatial.dll
Syntax
public class ShapePredicateValueSource : ValueSource

Constructors

ShapePredicateValueSource(ValueSource, SpatialOperation, IShape)

A boolean Lucene.Net.Queries.Function.ValueSource that compares a shape from a provided Lucene.Net.Queries.Function.ValueSource with a given Spatial4n.Shapes.IShape and sees if it matches a given SpatialOperation (the predicate).

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration
public ShapePredicateValueSource(ValueSource shapeValueSource, SpatialOperation op, IShape queryShape)
Parameters
Type Name Description
ValueSource shapeValueSource

Must yield Spatial4n.Shapes.IShape instances from it's ObjectVal(doc). If null then the result is false. This is the left-hand (indexed) side.
SpatialOperation op

the predicate
IShape queryShape

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

Methods

CreateWeight(IDictionary, IndexSearcher)

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.

Declaration
public override void CreateWeight(IDictionary context, IndexSearcher searcher)
Parameters
Type Name Description
IDictionary context
IndexSearcher searcher
Overrides

Equals(object?)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object? o)
Parameters
Type Name Description
object o
Returns
Type Description
bool

true if the specified object is equal to the current object; otherwise, false.
Overrides

GetDescription()

description of field, used in Explain()

Declaration
public override string GetDescription()
Returns
Type Description
string
Overrides
Lucene.Net.Queries.Function.ValueSource.GetDescription()

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.
Overrides
Lucene.Net.Queries.Function.ValueSource.GetHashCode()

GetValues(IDictionary, AtomicReaderContext)

Gets the values for this reader and the context that was previously passed to CreateWeight(IDictionary, IndexSearcher)

Declaration
public override FunctionValues GetValues(IDictionary context, AtomicReaderContext readerContext)
Parameters
Type Name Description
IDictionary context
AtomicReaderContext readerContext
Returns
Type Description
FunctionValues
Overrides