This package provides the ability to mark terms, spans, and context around
spans within the contents of a stored document field.
Here are the general steps to use this functionality:
- Create a query using Lucene's Span system (i.e. use classes derived from
SpanQuery).
- On the top level query, turn on span recording by calling setSpanRecording()
on the query.
- Run the query. Each Document returned will in reality be a SpanDocument.
- Call one of the markField() methods of SpanDocument
and supply a MarkCollector to collect the
resulting marks.