org.compass.annotations
Annotation Type SearchableAllMetaData


@Target(value=TYPE)
@Retention(value=RUNTIME)
public @interface SearchableAllMetaData

For Searchable classes, allows to control the "all" meta-data definitions per searchable class.

The "all" meta-data is an internal meta-data, which holds searchable information of all the class searchable content.

The definitions here are per searchable class definitions. For global control of the "all" meta-data see CompassEnvironment.All settings.

Author:
kimchy
See Also:
Searchable

Optional Element Summary
 EnableAll enable
          Controls if the searchable class will create it's own internal "all" meta-data.
 ExcludeAlias excludeAlias
          Controls is the alias will be stored within the "all" proeprty or not.
 NABoolean includePropertiesWithNoMappings
          Set to TRUE if when adding the different Resource properties, properties with no mappings will be added to the "all" property.
 String name
          The name of the "all" meta-data that will be created.
 OmitNorms omitNorms
          Expert: If set, omit normalization factors associated with this indexed field.
 OmitTf omitTf
          Expert: If set, omit tf from postings of this indexed field.
 SpellCheck spellCheck
          Should this propety be included in the spell check index.
 TermVector termVector
          The term vector for the "all" meta-data.
 

name

public abstract String name
The name of the "all" meta-data that will be created. Defaults to the global setting.

Default:
""

enable

public abstract EnableAll enable
Controls if the searchable class will create it's own internal "all" meta-data. The "all" meta-data holds searchable information of all the class searchable content.

If using the "all" meta-data, it can be controlled using the SearchableAllMetaData annotation.

Default:
NA

termVector

public abstract TermVector termVector
The term vector for the "all" meta-data.

Default:
NO

excludeAlias

public abstract ExcludeAlias excludeAlias
Controls is the alias will be stored within the "all" proeprty or not.

Default:
NA

includePropertiesWithNoMappings

public abstract NABoolean includePropertiesWithNoMappings
Set to TRUE if when adding the different Resource properties, properties with no mappings will be added to the "all" property. A resoruce can have property with no mappings if it was added programtically to the resource.

See CompassEnvironment.All.INCLUDE_UNMAPPED_PROPERTIES for system wide setting and teh defult value if this is set to NA.

Default:
NA

omitNorms

public abstract OmitNorms omitNorms
Expert: If set, omit normalization factors associated with this indexed field. This effectively disables indexing boosts and length normalization for this field.

Default:
NO

omitTf

public abstract OmitTf omitTf
Expert: If set, omit tf from postings of this indexed field.

Default:
NO

spellCheck

public abstract SpellCheck spellCheck
Should this propety be included in the spell check index.

Note, most times this is not requried to be configured, since by default, the spell check index uses the "all" property.

Default:
EXCLUDE


Copyright (c) 2004-2009 The Compass Project.