nl.inl.blacklab.mocks

Class MockSpans

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.search.spans.Spans

nl.inl.blacklab.search.lucene.BLSpans

nl.inl.blacklab.mocks.MockSpans

public class MockSpans
extends BLSpans

Stub Spans class for testing. Takes arrays and iterates through 'hits' from these arrays.

Field Summary

Fields inherited from class nl.inl.blacklab.search.lucene.BLSpans

childClausesCaptureGroups, MAX_UNLIMITED

Fields inherited from class org.apache.lucene.search.spans.Spans

NO_MORE_POSITIONS

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

NO_MORE_DOCS

Constructor Summary

Constructors

Constructor and Description
MockSpans(int[] doc, int[] start, int[] end)

Method Summary

Modifier and Type	Method and Description
int	advance(int target)
void	collect(org.apache.lucene.search.spans.SpanCollector collector)
int	docID()
static MockSpans	emptySpans()
int	endPosition()
static MockSpans	fromLists(int[] doc, int[] start, int[] end)
void	getCapturedGroups(Span[] capturedGroups) Get the start and end position for the captured groups contained in this BLSpans (sub)tree.
int	nextDoc()
int	nextStartPosition()
void	passHitQueryContextToClauses(HitQueryContext context) Called by setHitQueryContext() to pass the context to child clauses.
float	positionsCost()
static MockSpans	single(int doc, int start, int end)
int	startPosition()
int	width()
static MockSpans	withEndInPayload(int[] aDoc, int[] aStart, int[] aEnd)

Methods inherited from class nl.inl.blacklab.search.lucene.BLSpans

advanceStartPosition, cost, optSortUniq, setHitQueryContext

Methods inherited from class org.apache.lucene.search.spans.Spans

asTwoPhaseIterator, doCurrentSpans, doStartCurrentDoc, toString

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

all, empty, slowAdvance

Methods inherited from class java.lang.Object

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

Constructor Detail

MockSpans

public MockSpans(int[] doc,
                 int[] start,
                 int[] end)

Method Detail

docID

public int docID()

Specified by:

docID in class org.apache.lucene.search.DocIdSetIterator

endPosition

public int endPosition()

Specified by:

endPosition in class org.apache.lucene.search.spans.Spans

nextDoc

public int nextDoc()
            throws IOException

Specified by:

nextDoc in class org.apache.lucene.search.DocIdSetIterator

Throws:

IOException

nextStartPosition

public int nextStartPosition()
                      throws IOException

Specified by:

nextStartPosition in class org.apache.lucene.search.spans.Spans

Throws:

IOException

advance

public int advance(int target)
            throws IOException

Specified by:

advance in class org.apache.lucene.search.DocIdSetIterator

Throws:

IOException

startPosition

public int startPosition()

Specified by:

startPosition in class org.apache.lucene.search.spans.Spans

passHitQueryContextToClauses

public void passHitQueryContextToClauses(HitQueryContext context)

Description copied from class: BLSpans

Called by setHitQueryContext() to pass the context to child clauses.

Specified by:

passHitQueryContextToClauses in class BLSpans

Parameters:

context - the hit query context, that e.g. keeps track of captured groups

getCapturedGroups

public void getCapturedGroups(Span[] capturedGroups)

Description copied from class: BLSpans

Get the start and end position for the captured groups contained in this BLSpans (sub)tree.

Specified by:

getCapturedGroups in class BLSpans

Parameters:

capturedGroups - an array the size of the total number of groups in the query; the start and end positions for the groups in this subtree will be placed in here.

emptySpans

public static MockSpans emptySpans()

single

public static MockSpans single(int doc,
                               int start,
                               int end)

fromLists

public static MockSpans fromLists(int[] doc,
                                  int[] start,
                                  int[] end)

withEndInPayload

public static MockSpans withEndInPayload(int[] aDoc,
                                         int[] aStart,
                                         int[] aEnd)

width

public int width()

Specified by:

width in class org.apache.lucene.search.spans.Spans

collect

public void collect(org.apache.lucene.search.spans.SpanCollector collector)
             throws IOException

Specified by:

collect in class org.apache.lucene.search.spans.Spans

Throws:

IOException

positionsCost

public float positionsCost()

Specified by:

positionsCost in class org.apache.lucene.search.spans.Spans