org.compass.core.engine
Interface SearchEngineHighlighter

All Known Implementing Classes:

LuceneSearchEngineHighlighter

public interface SearchEngineHighlighter

Author:

kimchy

Method Summary

SearchEngineHighlighter	clear()
void	close()
String	fragment(Resource resource, String propertyName)
String	fragment(Resource resource, String propertyName, String text)
String[]	fragments(Resource resource, String propertyName)
String[]	fragments(Resource resource, String propertyName, String text)
String	fragmentsWithSeparator(Resource resource, String propertyName)
String	fragmentsWithSeparator(Resource resource, String propertyName, String text)
String[]	multiValueFragment(Resource resource, String propertyName)
String[]	multiValueFragment(Resource resource, String propertyName, String[] texts)
String	multiValueFragmentWithSeparator(Resource resource, String propertyName)
String	multiValueFragmentWithSeparator(Resource resource, String propertyName, String[] texts)
SearchEngineHighlighter	setAnalyzer(Resource resource)
SearchEngineHighlighter	setAnalyzer(String analyzerName)
SearchEngineHighlighter	setHighlighter(String highlighterName)
SearchEngineHighlighter	setMaxBytesToAnalyze(int maxBytesToAnalyze)
SearchEngineHighlighter	setMaxNumFragments(int maxNumFragments)
SearchEngineHighlighter	setSeparator(String separator)
SearchEngineHighlighter	setTextTokenizer(CompassHighlighter.TextTokenizer textTokenizer)

Method Detail

clear

SearchEngineHighlighter clear()

close

void close()
           throws SearchEngineException

Throws:

SearchEngineException

setHighlighter

SearchEngineHighlighter setHighlighter(String highlighterName)
                                       throws SearchEngineException

Throws:

SearchEngineException

setAnalyzer

SearchEngineHighlighter setAnalyzer(String analyzerName)
                                    throws SearchEngineException

Throws:

SearchEngineException

setAnalyzer

SearchEngineHighlighter setAnalyzer(Resource resource)
                                    throws SearchEngineException

Throws:

SearchEngineException

setSeparator

SearchEngineHighlighter setSeparator(String separator)
                                     throws SearchEngineException

Throws:

SearchEngineException

setMaxNumFragments

SearchEngineHighlighter setMaxNumFragments(int maxNumFragments)
                                           throws SearchEngineException

Throws:

SearchEngineException

setMaxBytesToAnalyze

SearchEngineHighlighter setMaxBytesToAnalyze(int maxBytesToAnalyze)
                                             throws SearchEngineException

Throws:

SearchEngineException

setTextTokenizer

SearchEngineHighlighter setTextTokenizer(CompassHighlighter.TextTokenizer textTokenizer)
                                         throws SearchEngineException

Throws:

SearchEngineException

fragment

String fragment(Resource resource,
                String propertyName)
                throws SearchEngineException

Throws:

SearchEngineException

fragment

String fragment(Resource resource,
                String propertyName,
                String text)
                throws SearchEngineException

Throws:

SearchEngineException

fragments

String[] fragments(Resource resource,
                   String propertyName)
                   throws SearchEngineException

Throws:

SearchEngineException

fragments

String[] fragments(Resource resource,
                   String propertyName,
                   String text)
                   throws SearchEngineException

Throws:

SearchEngineException

fragmentsWithSeparator

String fragmentsWithSeparator(Resource resource,
                              String propertyName)
                              throws SearchEngineException

Throws:

SearchEngineException

fragmentsWithSeparator

String fragmentsWithSeparator(Resource resource,
                              String propertyName,
                              String text)
                              throws SearchEngineException

Throws:

SearchEngineException

multiValueFragment

String[] multiValueFragment(Resource resource,
                            String propertyName)
                            throws SearchEngineException

Throws:

SearchEngineException

multiValueFragment

String[] multiValueFragment(Resource resource,
                            String propertyName,
                            String[] texts)
                            throws SearchEngineException

Throws:

SearchEngineException

multiValueFragmentWithSeparator

String multiValueFragmentWithSeparator(Resource resource,
                                       String propertyName)
                                       throws SearchEngineException

Throws:

SearchEngineException

multiValueFragmentWithSeparator

String multiValueFragmentWithSeparator(Resource resource,
                                       String propertyName,
                                       String[] texts)
                                       throws SearchEngineException

Throws:

SearchEngineException