Lucene.Net.Search.Highlight.IFragmenter Interface Reference

Implements the policy for breaking text into multiple fragments for consideration by the Highlighter class. A sophisticated implementation may do this on the basis of detecting end of sentences in the text. More...

Inherited by Lucene.Net.Search.Highlight.NullFragmenter, Lucene.Net.Search.Highlight.SimpleFragmenter, and Lucene.Net.Search.Highlight.SimpleSpanFragmenter.

Public Member Functions
void	Start (string originalText, TokenStream tokenStream)
	Initializes the Fragmenter. You can grab references to the Attributes you are interested in from tokenStream and then access the values in isNewFragment().
bool	IsNewFragment ()
	Test to see if this token from the stream should be held in a new TextFragment. Every time this is called, the TokenStream passed to start(String, TokenStream) will have been incremented.

Detailed Description

Implements the policy for breaking text into multiple fragments for consideration by the Highlighter class. A sophisticated implementation may do this on the basis of detecting end of sentences in the text.

<author> mark@.nosp@m.sear.nosp@m.chare.nosp@m.a.co.nosp@m..uk </author>

Definition at line 29 of file IFragmenter.cs.

Member Function Documentation

bool Lucene.Net.Search.Highlight.IFragmenter.IsNewFragment

(

)

Test to see if this token from the stream should be held in a new TextFragment. Every time this is called, the TokenStream passed to start(String, TokenStream) will have been incremented.

Implemented in Lucene.Net.Search.Highlight.SimpleFragmenter, Lucene.Net.Search.Highlight.SimpleSpanFragmenter, and Lucene.Net.Search.Highlight.NullFragmenter.

void Lucene.Net.Search.Highlight.IFragmenter.Start	(	string	originalText,
		TokenStream	tokenStream
	)

Initializes the Fragmenter. You can grab references to the Attributes you are interested in from tokenStream and then access the values in isNewFragment().

Parameters

originalText

the original source text

param name="tokenStream">tokenStream the TokenStream to be fragmented

Implemented in Lucene.Net.Search.Highlight.NullFragmenter.

---

The documentation for this interface was generated from the following file:

• contrib/Highlighter/IFragmenter.cs