org.compass.core.config
Class CompassEnvironment.All

java.lang.Object
  org.compass.core.config.CompassEnvironment.All

Enclosing class:

CompassEnvironment

public abstract class CompassEnvironment.All
extends Object

Settings relating to the "all" property.

Field Summary

static String	BOOST_SUPPORT Should the all property honor boost settings on sepecific proeprties when searching.
static String	DEFAULT_NAME The default name for the "all" property.
static String	ENABLED If all property will be globablly enabled or not.
static String	EXCLUDE_ALIAS Should the all property exclude the alias from all.
static String	INCLUDE_UNMAPPED_PROPERTIES Should the all property include data from properties that do not have an explicit mapping.
static String	NAME Controls the name of the "all" property.
static String	OMIT_NORMS Should the all property omit norms.
static String	OMIT_TF Should the all property omit tf.
static String	TERM_VECTOR The term vector the will be used with the all property.

Constructor Summary

CompassEnvironment.All()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

Controls the name of the "all" property.

See Also:

Constant Field Values

DEFAULT_NAME

public static final String DEFAULT_NAME

The default name for the "all" property. Defaults to zzz-all.

See Also:

Constant Field Values

TERM_VECTOR

public static final String TERM_VECTOR

The term vector the will be used with the all property. Can be one out of: no, yes, positions, offsets, positions_offsets.

See Also:

Constant Field Values

ENABLED

public static final String ENABLED

If all property will be globablly enabled or not. By default it is enabled.

Note, enabling and disabling all property can also be done on the mapping itself. If it is explicitly defined on the mappings, then it will override this setting.

See Also:

Constant Field Values

EXCLUDE_ALIAS

public static final String EXCLUDE_ALIAS

Should the all property exclude the alias from all. Defaults to true.

Note, this can be explicitly set on the mapping level, which will then be used instead of this global setting.

See Also:

Constant Field Values

OMIT_NORMS

public static final String OMIT_NORMS

Should the all property omit norms. Defaults to false.

Note, this can be explicitly set on the mapping level, which will then be used instead of this global setting.

See Also:

Constant Field Values

OMIT_TF

public static final String OMIT_TF

Should the all property omit tf. Defaults to false.

Note, this can be explicitly set on the mapping level, which will then be used instead of this global setting.

See Also:

Constant Field Values

BOOST_SUPPORT

public static final String BOOST_SUPPORT

Should the all property honor boost settings on sepecific proeprties when searching. Defaults to true.

If set to true, more data will be saved in the index in case of a specific boost value, but searching experiance will be much improved.

See Also:

Constant Field Values

INCLUDE_UNMAPPED_PROPERTIES

public static final String INCLUDE_UNMAPPED_PROPERTIES

Should the all property include data from properties that do not have an explicit mapping. Defaults to true.

See Also:

Constant Field Values

Constructor Detail

CompassEnvironment.All

public CompassEnvironment.All()