org.apache.lucene.spatial.bbox

Class BBoxSimilarityValueSource

java.lang.Object

org.apache.lucene.search.DoubleValuesSource

org.apache.lucene.spatial.bbox.BBoxSimilarityValueSource

All Implemented Interfaces:

SegmentCacheable

Direct Known Subclasses:

BBoxOverlapRatioValueSource

public abstract class BBoxSimilarityValueSource
extends DoubleValuesSource

A base class for calculating a spatial relevance rank per document from a provided ShapeValuesSource returning a Rectangle per-document.

Implementers: remember to implement equals and hashCode if you have fields!

Field Summary

Fields inherited from class org.apache.lucene.search.DoubleValuesSource

SCORES

Constructor Summary

Constructors

Constructor and Description
BBoxSimilarityValueSource(ShapeValuesSource bboxValueSource)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
Explanation	explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation) An explanation of the value for the named document.
DoubleValues	getValues(LeafReaderContext readerContext, DoubleValues scores) Returns a DoubleValues instance for the passed-in LeafReaderContext and scores If scores are not needed to calculate the values (ie returns false, callers may safely pass null for the scores parameter.
int	hashCode()
boolean	isCacheable(LeafReaderContext ctx)
boolean	needsScores() Return true if document scores are needed to calculate values
DoubleValuesSource	rewrite(IndexSearcher searcher) Return a DoubleValuesSource specialised for the given IndexSearcher Implementations should assume that this will only be called once.
protected abstract double	score(org.locationtech.spatial4j.shape.Rectangle rect, java.util.concurrent.atomic.AtomicReference<Explanation> exp) Return a relevancy score.
protected abstract java.lang.String	similarityDescription() A comma-separated list of configurable items of the subclass to put into toString().
java.lang.String	toString()

Methods inherited from class org.apache.lucene.search.DoubleValuesSource

constant, fromDoubleField, fromField, fromFloatField, fromIntField, fromLongField, fromQuery, fromScorer, getSortField, toLongValuesSource

Methods inherited from class java.lang.Object

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

Constructor Detail

BBoxSimilarityValueSource

public BBoxSimilarityValueSource(ShapeValuesSource bboxValueSource)

Method Detail

rewrite

public DoubleValuesSource rewrite(IndexSearcher searcher)
                           throws java.io.IOException

Description copied from class: DoubleValuesSource

Return a DoubleValuesSource specialised for the given IndexSearcher Implementations should assume that this will only be called once. IndexReader-independent implementations can just return this Queries that use DoubleValuesSource objects should call rewrite() during Query.createWeight(IndexSearcher, boolean, float) rather than during Query.rewrite(IndexReader) to avoid IndexReader reference leakage

Specified by:

rewrite in class DoubleValuesSource

Throws:

java.io.IOException

toString

public java.lang.String toString()

Specified by:

toString in class DoubleValuesSource

similarityDescription

protected abstract java.lang.String similarityDescription()

A comma-separated list of configurable items of the subclass to put into toString().

getValues

public DoubleValues getValues(LeafReaderContext readerContext,
                              DoubleValues scores)
                       throws java.io.IOException

Description copied from class: DoubleValuesSource

Returns a DoubleValues instance for the passed-in LeafReaderContext and scores If scores are not needed to calculate the values (ie returns false, callers may safely pass null for the scores parameter.

Specified by:

getValues in class DoubleValuesSource

Throws:

java.io.IOException

score

protected abstract double score(org.locationtech.spatial4j.shape.Rectangle rect,
                                java.util.concurrent.atomic.AtomicReference<Explanation> exp)

Return a relevancy score. If exp is provided then diagnostic information is added.

Parameters:

rect - The indexed rectangle; not null.

exp - Optional diagnostic holder.

Returns:

a score.

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in class DoubleValuesSource

hashCode

public int hashCode()

Specified by:

hashCode in class DoubleValuesSource

explain

public Explanation explain(LeafReaderContext ctx,
                           int docId,
                           Explanation scoreExplanation)
                    throws java.io.IOException

Description copied from class: DoubleValuesSource

An explanation of the value for the named document.

Overrides:

explain in class DoubleValuesSource

Parameters:

ctx - the readers context to create the Explanation for.

docId - the document's id relative to the given context's reader

Returns:

an Explanation for the value

Throws:

java.io.IOException - if an IOException occurs

isCacheable

public boolean isCacheable(LeafReaderContext ctx)

Returns:

true if the object can be cached against a given leaf

needsScores

public boolean needsScores()

Description copied from class: DoubleValuesSource

Return true if document scores are needed to calculate values

Specified by:

needsScores in class DoubleValuesSource