Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
IFragmenter.cs
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 using Lucene.Net.Analysis;
19 
20 namespace Lucene.Net.Search.Highlight
21 {
22 
23  /// <summary> Implements the policy for breaking text into multiple fragments for consideration
24  /// by the <see cref="Highlighter"/> class. A sophisticated implementation may do this on the basis
25  /// of detecting end of sentences in the text.
26  /// </summary>
27  /// <author> mark@searcharea.co.uk
28  /// </author>
29  public interface IFragmenter
30  {
31  /// <summary>
32  /// Initializes the Fragmenter. You can grab references to the Attributes you are
33  /// interested in from tokenStream and then access the values in {@link #isNewFragment()}.
34  /// </summary>
35  /// <param name="originalText">the original source text</param>
36  ///<param name="tokenStream">tokenStream the <see cref="TokenStream" /> to be fragmented</param>
37  void Start(string originalText, TokenStream tokenStream);
38 
39  /// <summary>
40  /// Test to see if this token from the stream should be held in a new
41  /// TextFragment. Every time this is called, the TokenStream
42  /// passed to start(String, TokenStream) will have been incremented.
43  /// </summary>
44  bool IsNewFragment();
45  }
46 }