org.compass.core.mapping
Interface AllMapping

All Known Subinterfaces:
InternalAllMapping
All Known Implementing Classes:
DefaultAllMapping

public interface AllMapping

A set of settings associated with the all mapping.

Author:
kimchy

Method Summary
 AllMapping copy()
          Returns a copy of the All mapping settings.
 String getProperty()
          Returns the name of the all property for the given resoruce.
 SpellCheckType getSpellCheck()
           
 Property.TermVector getTermVector()
          Returns the term vector configuration for the given all proeprty.
 Boolean isExcludeAlias()
          Should the alias be excluded from the "all" property.
 Boolean isIncludePropertiesWithNoMappings()
          Returns true if when adding the different Resource properties, properties with no mappings will be added to the "all" property.
 Boolean isOmitNorms()
          Expert: If set, omit normalization factors associated with this indexed field.
 Boolean isSupported()
          Returns true if the "all" property will be created for the resource.
 

Method Detail

isSupported

Boolean isSupported()
Returns true if the "all" property will be created for the resource. The all property is a special property that have all the other resource values in it to be searchable.


isExcludeAlias

Boolean isExcludeAlias()
Should the alias be excluded from the "all" property. Default should be false.


isIncludePropertiesWithNoMappings

Boolean isIncludePropertiesWithNoMappings()
Returns 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.


getProperty

String getProperty()
Returns the name of the all property for the given resoruce.


getTermVector

Property.TermVector getTermVector()
Returns the term vector configuration for the given all proeprty.


isOmitNorms

Boolean isOmitNorms()
Expert: If set, omit normalization factors associated with this indexed field. This effectively disables indexing boosts and length normalization for this field.


getSpellCheck

SpellCheckType getSpellCheck()

copy

AllMapping copy()
Returns a copy of the All mapping settings.



Copyright (c) 2004-2008 The Compass Project.