nl.inl.blacklab.search.fimatch

Class ForwardIndexAccessor

java.lang.Object

nl.inl.blacklab.search.fimatch.ForwardIndexAccessor

public abstract class ForwardIndexAccessor
extends Object

Allows the forward index matching subsystem to access the forward indices, including an easy and fast way to read any annotation at any position from a document.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ForwardIndexAccessor.ForwardIndexAccessorLeafReader

Constructor Summary

Constructors

Constructor and Description
ForwardIndexAccessor()

Method Summary

Modifier and Type	Method and Description
static ForwardIndexAccessor	fromIndex(BlackLabIndex index, String searchField)
abstract int	getAnnotationNumber(Annotation annotation) Get the index number corresponding to the given annotation name.
abstract int	getAnnotationNumber(String annotationName) Get the index number corresponding to the given annotation name.
abstract ForwardIndexAccessor.ForwardIndexAccessorLeafReader	getForwardIndexAccessorLeafReader(org.apache.lucene.index.LeafReader reader) Get an accessor for forward index documents from this leafreader.
abstract void	getTermNumbers(org.eclipse.collections.api.set.primitive.MutableIntSet results, int annotationNumber, String annotationValue, MatchSensitivity sensitivity) Get the term number for a given term string.
abstract String	getTermString(int annotIndex, int termId)
abstract int	numberOfAnnotations() Get the number of annotations
abstract boolean	termsEqual(int annotIndex, int[] termId, MatchSensitivity sensitivity)

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardIndexAccessor

public ForwardIndexAccessor()

Method Detail

fromIndex

public static ForwardIndexAccessor fromIndex(BlackLabIndex index,
                                             String searchField)

getAnnotationNumber

public abstract int getAnnotationNumber(Annotation annotation)

Get the index number corresponding to the given annotation name.

Parameters:

annotation - annotation to get the index for

Returns:

index for this annotation

getAnnotationNumber

public abstract int getAnnotationNumber(String annotationName)

Get the index number corresponding to the given annotation name.

Parameters:

annotationName - annotation to get the index for

Returns:

index for this annotation

getTermNumbers

public abstract void getTermNumbers(org.eclipse.collections.api.set.primitive.MutableIntSet results,
                                    int annotationNumber,
                                    String annotationValue,
                                    MatchSensitivity sensitivity)

Get the term number for a given term string.

Parameters:

results - (out) term number for this term in this annotation

annotationNumber - which annotation to get term number for

annotationValue - which term string to get term number for

sensitivity - match sensitively or not? (currently both or neither)

numberOfAnnotations

public abstract int numberOfAnnotations()

Get the number of annotations

Returns:

number of annotations

getForwardIndexAccessorLeafReader

public abstract ForwardIndexAccessor.ForwardIndexAccessorLeafReader getForwardIndexAccessorLeafReader(org.apache.lucene.index.LeafReader reader)

Get an accessor for forward index documents from this leafreader.

Parameters:

reader - index reader

Returns:

reader-specific accessor

getTermString

public abstract String getTermString(int annotIndex,
                                     int termId)

termsEqual

public abstract boolean termsEqual(int annotIndex,
                                   int[] termId,
                                   MatchSensitivity sensitivity)