nl.inl.blacklab.search.fimatch

Class NfaStateMultiTermPattern

java.lang.Object

nl.inl.blacklab.search.fimatch.NfaState

nl.inl.blacklab.search.fimatch.NfaStateMultiTermPattern

Direct Known Subclasses:

NfaStateRegex

public abstract class NfaStateMultiTermPattern
extends NfaState

A regex, wildcard or prefix clause.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	luceneField What annotation we're trying to match
protected NfaState	nextState The next state if a matching token was found.
protected String	pattern The pattern this state accepts.

Constructor Summary

Constructors

Constructor and Description
NfaStateMultiTermPattern(String luceneField, String pattern, NfaState nextState)

Method Summary

Modifier and Type	Method and Description
protected String	dumpInternal(Map<NfaState,Integer> stateNrs)
boolean	findMatchesInternal(ForwardIndexDocument fiDoc, int pos, int direction, Set<Integer> matchEnds) Find all matches for this NFA in the token source.
protected void	finishInternal(Set<NfaState> visited) Visit each node and replace dangling arrows (nulls) with the match state.
boolean	hitsAllSameLength(Set<NfaState> statesVisited) Are all hits from this NFA the same length?
int	hitsLengthMax(Set<NfaState> statesVisited) What's the maximum hit length?
int	hitsLengthMin(Set<NfaState> statesVisited) What's the minimum hit length?
void	lookupPropertyNumbersInternal(ForwardIndexAccessor fiAccessor, Map<NfaState,Boolean> statesVisited)
boolean	matchesEmptySequence(Set<NfaState> statesVisited) Does this NFA match the empty sequence?
void	setNextState(int i, NfaState state) Set the next state for a given input.

Methods inherited from class nl.inl.blacklab.search.fimatch.NfaState

and, anyToken, dump, dump, emptySet, findMatches, finish, lookupPropertyNumbers, match, matches, or, regex, token, token, toString

Methods inherited from class java.lang.Object

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

Field Detail

luceneField

protected String luceneField

What annotation we're trying to match

pattern

protected String pattern

The pattern this state accepts.

nextState

protected NfaState nextState

The next state if a matching token was found.

Constructor Detail

NfaStateMultiTermPattern

public NfaStateMultiTermPattern(String luceneField,
                                String pattern,
                                NfaState nextState)

Method Detail

findMatchesInternal

public boolean findMatchesInternal(ForwardIndexDocument fiDoc,
                                   int pos,
                                   int direction,
                                   Set<Integer> matchEnds)

Find all matches for this NFA in the token source.

Parameters:

fiDoc - where to read tokens from

pos - current matching position

matchEnds - where to collect the matches found, or null if we don't want to collect them

direction - matching direction

Returns:

true if any (new) matches were found, false if not

setNextState

public void setNextState(int i,
                         NfaState state)

Description copied from class: NfaState

Set the next state for a given input.

Specified by:

setNextState in class NfaState

Parameters:

i - input

state - next state

matchesEmptySequence

public boolean matchesEmptySequence(Set<NfaState> statesVisited)

Description copied from class: NfaState

Does this NFA match the empty sequence?

Specified by:

matchesEmptySequence in class NfaState

Parameters:

statesVisited - states we've already visited, so we can deal with cycles

Returns:

true if it matches the empty sequence, false if not

hitsAllSameLength

public boolean hitsAllSameLength(Set<NfaState> statesVisited)

Description copied from class: NfaState

Are all hits from this NFA the same length?

Specified by:

hitsAllSameLength in class NfaState

Parameters:

statesVisited - states we've already visited, so we can deal with cycles

Returns:

true if all hits are the same length, false if not

hitsLengthMin

public int hitsLengthMin(Set<NfaState> statesVisited)

Description copied from class: NfaState

What's the minimum hit length?

Specified by:

hitsLengthMin in class NfaState

Parameters:

statesVisited - states we've already visited, so we can deal with cycles

Returns:

minimum hit length

hitsLengthMax

public int hitsLengthMax(Set<NfaState> statesVisited)

Description copied from class: NfaState

What's the maximum hit length?

Specified by:

hitsLengthMax in class NfaState

Parameters:

statesVisited - states we've already visited, so we can deal with cycles

Returns:

maximum hit length

dumpInternal

protected String dumpInternal(Map<NfaState,Integer> stateNrs)

Specified by:

dumpInternal in class NfaState

lookupPropertyNumbersInternal

public void lookupPropertyNumbersInternal(ForwardIndexAccessor fiAccessor,
                                          Map<NfaState,Boolean> statesVisited)

finishInternal

protected void finishInternal(Set<NfaState> visited)

Description copied from class: NfaState

Visit each node and replace dangling arrows (nulls) with the match state.

Specified by:

finishInternal in class NfaState

Parameters:

visited - nodes visited so far, this one included. finish() uses this to make sure we don't visit the same node twice, so always call finish() in your implementations, not finishInternal().