org.compass.core.lucene
Class LuceneEnvironment.Highlighter

java.lang.Object
  extended by org.compass.core.lucene.LuceneEnvironment.Highlighter
Enclosing class:
LuceneEnvironment

public abstract static class LuceneEnvironment.Highlighter
extends Object

Settings for Lucene highlighter.

Author:
kimchy

Nested Class Summary
 class LuceneEnvironment.Highlighter.Encoder
           
 class LuceneEnvironment.Highlighter.Formatter
          Settings for Lucene highlighter formatter.
 class LuceneEnvironment.Highlighter.Fragmenter
          Settings for Lucene highlighter fragmenter.
 
Field Summary
static String COMPUTE_IDF
          Low level.
static String DEFAULT_GROUP
          The default highlighter group that must be set.
static String FACTORY
          The fully qualified name of the highlighter factory or an actual instance.
static String MAX_BYTES_TO_ANALYZE
          Maximum bytes to analyze.
static String MAX_NUM_FRAGMENTS
          Sets the maximum number of fragments that will be returned.
static String PREFIX
          The prefix used for highlighter groups.
static String REWRITE_QUERY
          Low level.
static String SEPARATOR
          Sets the separator string between fragments if using the combined fragments highlight option.
static String TEXT_TOKENIZER
          The text tokenizer type that will be used.
 
Constructor Summary
LuceneEnvironment.Highlighter()
           
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PREFIX

public static final String PREFIX
The prefix used for highlighter groups.

See Also:
Constant Field Values

DEFAULT_GROUP

public static final String DEFAULT_GROUP
The default highlighter group that must be set.

See Also:
Constant Field Values

TEXT_TOKENIZER

public static final String TEXT_TOKENIZER
The text tokenizer type that will be used.

See Also:
Constant Field Values

REWRITE_QUERY

public static final String REWRITE_QUERY
Low level. A boolean setting (true, or false). If the query will be rewritten befored it is used by the highlighter.

See Also:
Constant Field Values

COMPUTE_IDF

public static final String COMPUTE_IDF
Low level. A boolean setting (true or false). If the idf value will be used during the highlighting process. Used by formatters that a) score selected fragments better b) use graded highlights eg chaning intensity of font color. Automatically assigned for the provided formatters.

See Also:
Constant Field Values

MAX_NUM_FRAGMENTS

public static final String MAX_NUM_FRAGMENTS
Sets the maximum number of fragments that will be returned. Defaults to 3.

See Also:
Constant Field Values

SEPARATOR

public static final String SEPARATOR
Sets the separator string between fragments if using the combined fragments highlight option. Defaults to ....

See Also:
Constant Field Values

MAX_BYTES_TO_ANALYZE

public static final String MAX_BYTES_TO_ANALYZE
Maximum bytes to analyze. Default to 50*1024 bytes.

See Also:
Constant Field Values

FACTORY

public static final String FACTORY
The fully qualified name of the highlighter factory or an actual instance. Must implement the LuceneHighlighterFactory inteface.

It is part of the highlighter group, and should be constructed using the CompassSettings.setGroupSettings(String,String,String[],Object[]), with the PREFIX as the prefix, the highlighter group name, and the factory as one of the values.

See Also:
Constant Field Values
Constructor Detail

LuceneEnvironment.Highlighter

public LuceneEnvironment.Highlighter()


Copyright (c) 2004-2008 The Compass Project.