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