org.compass.core
Interface CompassHighlightedText

All Known Subinterfaces:

InternalCompassHighlightedText

All Known Implementing Classes:

DefaultCompassHighlightedText

public interface CompassHighlightedText

A cached holder of highlighted text.

Author:

kimchy

See Also:

CompassHitsOperations.highlightedText(int), CompassHits.highlighter(int)

Method Summary

String	getHighlightedText() Returns the first highlighted text cached.
String	getHighlightedText(String propertyName) Returns the highlighted text associated with the given property name.

Method Detail

getHighlightedText

String getHighlightedText()
                          throws CompassException

Returns the first highlighted text cached.

Throws:

CompassException

getHighlightedText

String getHighlightedText(String propertyName)
                          throws CompassException

Returns the highlighted text associated with the given property name.

Throws:

CompassException