Module org.apache.lucene.queries

Package org.apache.lucene.queries.function.valuesource

Class VectorFieldFunction

java.lang.Object

org.apache.lucene.queries.function.FunctionValues

org.apache.lucene.queries.function.valuesource.VectorFieldFunction

public abstract class VectorFieldFunction
extends FunctionValues

An implementation for retrieving FunctionValues instances for knn vectors fields.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.queries.function.FunctionValues

FunctionValues.ValueFiller

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	lastDocID
protected final ValueSource	valueSource

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VectorFieldFunction(ValueSource valueSource)

Method Summary

Modifier and Type	Method	Description
(package private) static void	checkField(LeafReader in, String field, VectorEncoding expectedEncoding)	Checks the Vector Encoding of a field
boolean	exists(int doc)	Returns true if there is a value for this document
protected abstract DocIdSetIterator	getVectorIterator()
String	toString(int doc)

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

boolVal, bytesVal, byteVal, byteVal, byteVectorVal, cost, doubleVal, doubleVal, explain, floatVal, floatVal, floatVectorVal, getRangeScorer, getScorer, getValueFiller, intVal, intVal, longVal, longVal, numOrd, objectVal, ordVal, shortVal, shortVal, strVal, strVal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

valueSource

protected final ValueSource valueSource

lastDocID

int lastDocID

Constructor Details

VectorFieldFunction

protected VectorFieldFunction(ValueSource valueSource)

Method Details

getVectorIterator

protected abstract DocIdSetIterator getVectorIterator()

toString

public String toString(int doc)
                throws IOException

Specified by:

toString in class FunctionValues

Throws:

IOException

exists

public boolean exists(int doc)
               throws IOException

Description copied from class: FunctionValues

Returns true if there is a value for this document

Overrides:

exists in class FunctionValues

Throws:

IOException

checkField

static void checkField(LeafReader in,
 String field,
 VectorEncoding expectedEncoding)

Checks the Vector Encoding of a field

Throws:

IllegalStateException - if field exists, but was not indexed with vectors.

IllegalStateException - if field has vectors, but using a different encoding