nl.inl.blacklab.search.fimatch

Class ForwardIndexDocument

java.lang.Object

nl.inl.blacklab.search.fimatch.ForwardIndexDocument

public abstract class ForwardIndexDocument
extends Object

Source of tokens for the forward index matching process.

Constructor Summary

Constructors

Constructor and Description
ForwardIndexDocument()

Method Summary

Modifier and Type	Method and Description
abstract String	getTermString(int annotIndex, int termId) Return string for term id
abstract int	getToken(int annotIndex, int pos) Return token at specified position.
abstract boolean	termsEqual(int annotIndex, int[] termId, MatchSensitivity sensitivity) Are all the specified term ids equal given these sensitivity settings?
abstract boolean	validPos(int pos) Is this position valid in this document?

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardIndexDocument

public ForwardIndexDocument()

Method Detail

getToken

public abstract int getToken(int annotIndex,
                             int pos)

Return token at specified position.

Parameters:

annotIndex - annotation to read

pos - position to read

Returns:

token at this position

getTermString

public abstract String getTermString(int annotIndex,
                                     int termId)

Return string for term id

Parameters:

annotIndex - annotation for which we want a term string

termId - term id

Returns:

corresponding term string

termsEqual

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

Are all the specified term ids equal given these sensitivity settings?

Parameters:

annotIndex - annotation we're looking at

termId - term ids we're comparing

sensitivity - whether we're comparing case-/diacritics-sensitively

Returns:

true if all are equal, false if not

validPos

public abstract boolean validPos(int pos)

Is this position valid in this document?

Parameters:

pos - position

Returns:

true if valid, false if not