01: package org.apache.lucene.search.highlight;
02:
03: /**
04: * Copyright 2002-2004 The Apache Software Foundation
05: *
06: * Licensed under the Apache License, Version 2.0 (the "License");
07: * you may not use this file except in compliance with the License.
08: * You may obtain a copy of the License at
09: *
10: * http://www.apache.org/licenses/LICENSE-2.0
11: *
12: * Unless required by applicable law or agreed to in writing, software
13: * distributed under the License is distributed on an "AS IS" BASIS,
14: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15: * See the License for the specific language governing permissions and
16: * limitations under the License.
17: */
18:
19: import org.apache.lucene.analysis.Token;
20:
21: /**
22: * Implements the policy for breaking text into multiple fragments for
23: * consideration by the {@link Highlighter} class. A sophisticated
24: * implementation may do this on the basis of detecting end of sentences in the
25: * text.
26: *
27: * @author mark@searcharea.co.uk
28: */
29: public interface Fragmenter {
30: /**
31: * Initializes the Fragmenter
32: *
33: * @param originalText
34: */
35: public void start(String originalText);
36:
37: /**
38: * Test to see if this token from the stream should be held in a new
39: * TextFragment
40: *
41: * @param nextToken
42: */
43: public boolean isNewFragment(Token nextToken);
44: }
|