01: /*
02: * Copyright 2004-2006 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16:
17: package org.compass.core;
18:
19: /**
20: * A cached holder of highlighted text.
21: *
22: * @author kimchy
23: * @see CompassHitsOperations#highlightedText(int)
24: * @see CompassHits#highlighter(int)
25: */
26: public interface CompassHighlightedText {
27:
28: /**
29: * Returns the first highlighted text cached.
30: */
31: String getHighlightedText() throws CompassException;
32:
33: /**
34: * Returns the highlighted text associated with the given property name.
35: */
36: String getHighlightedText(String propertyName)
37: throws CompassException;
38: }
|