org.compass.core.lucene
Class LuceneEnvironment.SpellCheck

java.lang.Object
  org.compass.core.lucene.LuceneEnvironment.SpellCheck

Enclosing class:

LuceneEnvironment

public abstract static class LuceneEnvironment.SpellCheck
extends Object

Field Summary

static String	ACCURACY The default accuracy that will be used.
static String	CLASS The FQN of the spell check class.
static String	DEFAULT_MODE The default mode for inclduing/excluding of proeprties from the spell check index.
static String	DEFAULT_PROPERTY The default property for the spell check.
static String	DICTIONARY_THRESHOLD Sets the dictionary threshold, which controls the minimum number of documents (of the total) where a term should appear.
static String	ENABLE Should the spell check module be enabled or not.
static String	GLOBAL_EXCLUDE_PROPERTY A globabl set of comma separated properties that will be exluded for each sub index.
static String	GLOBAL_INCLUDE_PROPERTIES A globabl set of comma separated properties that will be included for each sub index.
static String	NUMBER_OF_SUGGESTIONS The default number of suggestions.
static String	PREFIX
static String	SCHEDULE Set to true in order to have a scheduled task that rebuilds the spell index if needed.
static String	SCHEDULE_INITIAL_DELAY The initial delay of the scheduled rebuild.
static String	SCHEDULE_INTERVAL Set in seconds the interval at which a check and a possible rebuild of the spell check index will occur.

Constructor Summary

LuceneEnvironment.SpellCheck()

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

See Also:

Constant Field Values

ENABLE

public static final String ENABLE

Should the spell check module be enabled or not. Defaults to false.

See Also:

Constant Field Values

GLOBAL_INCLUDE_PROPERTIES

public static final String GLOBAL_INCLUDE_PROPERTIES

A globabl set of comma separated properties that will be included for each sub index.

See Also:

Constant Field Values

GLOBAL_EXCLUDE_PROPERTY

public static final String GLOBAL_EXCLUDE_PROPERTY

A globabl set of comma separated properties that will be exluded for each sub index.

See Also:

Constant Field Values

DEFAULT_PROPERTY

public static final String DEFAULT_PROPERTY

The default property for the spell check.

See Also:

Constant Field Values

DEFAULT_MODE

public static final String DEFAULT_MODE

The default mode for inclduing/excluding of proeprties from the spell check index. Only applies on resource mappings (class/resource/xml-object) that have their spell-check default value (which is NA).

If not set, will use just the all proeprty for mappings it can apply to. If set to INCLUDE will include by default all the given proeprties unless there are specific ones that have EXLCUDE mappings. If set to EXCLUDE will exclude all proeprties by default unless the given proeprties are marked with INCLUDE.

See Also:

Constant Field Values

ACCURACY

public static final String ACCURACY

The default accuracy that will be used. Defaults to 0.5.

See Also:

Constant Field Values

NUMBER_OF_SUGGESTIONS

public static final String NUMBER_OF_SUGGESTIONS

The default number of suggestions.

See Also:

Constant Field Values

DICTIONARY_THRESHOLD

public static final String DICTIONARY_THRESHOLD

Sets the dictionary threshold, which controls the minimum number of documents (of the total) where a term should appear. Defaults to 0.0f.

See Also:

Constant Field Values

SCHEDULE

public static final String SCHEDULE

Set to true in order to have a scheduled task that rebuilds the spell index if needed.

See Also:

Constant Field Values

SCHEDULE_INITIAL_DELAY

public static final String SCHEDULE_INITIAL_DELAY

The initial delay of the scheduled rebuild. In seconds. Defaults to 10 seconds.

See Also:

Constant Field Values

SCHEDULE_INTERVAL

public static final String SCHEDULE_INTERVAL

Set in seconds the interval at which a check and a possible rebuild of the spell check index will occur. Defaults to 10 minutes.

See Also:

Constant Field Values

CLASS

public static final String CLASS

The FQN of the spell check class.

See Also:

Constant Field Values

Constructor Detail

LuceneEnvironment.SpellCheck

public LuceneEnvironment.SpellCheck()