KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > lucene > search > highlight > Fragmenter


1 package org.apache.lucene.search.highlight;
2 /**
3  * Copyright 2002-2004 The Apache Software Foundation
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * 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 import org.apache.lucene.analysis.Token;
19
20 /**
21  * Implements the policy for breaking text into multiple fragments for consideration
22  * by the {@link Highlighter} class. A sophisticated implementation may do this on the basis
23  * of detecting end of sentences in the text.
24  * @author mark@searcharea.co.uk
25  */
26 public interface Fragmenter
27 {
28     /**
29      * Initializes the Fragmenter
30      * @param originalText
31      */
32     public void start(String JavaDoc originalText);
33
34     /**
35      * Test to see if this token from the stream should be held in a new TextFragment
36      * @param nextToken
37      * @return
38      */
39     public boolean isNewFragment(Token nextToken);
40 }
41
Popular Tags