org.compass.core.lucene
Class LuceneEnvironment.Highlighter.Formatter

java.lang.Object
  org.compass.core.lucene.LuceneEnvironment.Highlighter.Formatter

Enclosing class:

LuceneEnvironment.Highlighter

public abstract class LuceneEnvironment.Highlighter.Formatter
extends Object

Settings for Lucene highlighter formatter.

Author:

kimchy

Field Summary

static String	HTML_SPAN_GRADIENT Wraps an html span tag around the highlighted text.
static String	HTML_SPAN_GRADIENT_MAX_BACKGROUND_COLOR The largest hex color used for representing IDF scores eg #000000 (black) or null if no background color required.
static String	HTML_SPAN_GRADIENT_MAX_FOREGROUND_COLOR The largest hex color used for representing IDF scores eg #000000 (black) or null if no foreground color required.
static String	HTML_SPAN_GRADIENT_MAX_SCORE The score (and above) displayed as maxColor.
static String	HTML_SPAN_GRADIENT_MIN_BACKGROUND_COLOR The hex color used for representing IDF scores of zero eg #FFFFFF (white) or null if no background color required.
static String	HTML_SPAN_GRADIENT_MIN_FOREGROUND_COLOR The hex color used for representing IDF scores of zero eg #FFFFFF (white) or null if no foreground color required.
static String	SIMPLE A simple wrapper formatter.
static String	SIMPLE_POST_HIGHLIGHT In case the highlighter uses the SIMPLE, controlls the text that is appened after the highlighted text.
static String	SIMPLE_PRE_HIGHLIGHT In case the highlighter uses the SIMPLE, controlls the text that is appened before the highlighted text.
static String	TYPE If set, sets the type of the Lucene Formatter or it's fully qualified name.

Constructor Summary

LuceneEnvironment.Highlighter.Formatter()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE

public static final String TYPE

If set, sets the type of the Lucene Formatter or it's fully qualified name. Defaults to SIMPLE.

See Also:

Constant Field Values

SIMPLE

public static final String SIMPLE

A simple wrapper formatter. Wraps the highlight with pre and post string (can be html or xml tags). They can be set using SIMPLE_PRE_HIGHLIGHT and SIMPLE_POST_HIGHLIGHT.

See Also:

Constant Field Values

SIMPLE_PRE_HIGHLIGHT

public static final String SIMPLE_PRE_HIGHLIGHT

In case the highlighter uses the SIMPLE, controlls the text that is appened before the highlighted text. Defatuls to <b>.

See Also:

Constant Field Values

SIMPLE_POST_HIGHLIGHT

public static final String SIMPLE_POST_HIGHLIGHT

In case the highlighter uses the SIMPLE, controlls the text that is appened after the highlighted text. Defatuls to </b>.

See Also:

Constant Field Values

HTML_SPAN_GRADIENT

public static final String HTML_SPAN_GRADIENT

Wraps an html span tag around the highlighted text. The background and foreground colors can be controlled and will have different color intensity depending on the score.

See Also:

Constant Field Values

HTML_SPAN_GRADIENT_MAX_SCORE

public static final String HTML_SPAN_GRADIENT_MAX_SCORE

The score (and above) displayed as maxColor.

See Also:

Constant Field Values

HTML_SPAN_GRADIENT_MIN_FOREGROUND_COLOR

public static final String HTML_SPAN_GRADIENT_MIN_FOREGROUND_COLOR

The hex color used for representing IDF scores of zero eg #FFFFFF (white) or null if no foreground color required.

See Also:

Constant Field Values

HTML_SPAN_GRADIENT_MAX_FOREGROUND_COLOR

public static final String HTML_SPAN_GRADIENT_MAX_FOREGROUND_COLOR

The largest hex color used for representing IDF scores eg #000000 (black) or null if no foreground color required.

See Also:

Constant Field Values

HTML_SPAN_GRADIENT_MIN_BACKGROUND_COLOR

public static final String HTML_SPAN_GRADIENT_MIN_BACKGROUND_COLOR

The hex color used for representing IDF scores of zero eg #FFFFFF (white) or null if no background color required.

See Also:

Constant Field Values

HTML_SPAN_GRADIENT_MAX_BACKGROUND_COLOR

public static final String HTML_SPAN_GRADIENT_MAX_BACKGROUND_COLOR

The largest hex color used for representing IDF scores eg #000000 (black) or null if no background color required.

See Also:

Constant Field Values

Constructor Detail

LuceneEnvironment.Highlighter.Formatter

public LuceneEnvironment.Highlighter.Formatter()