org.compass.core.mapping.internal
Class DefaultAllMapping

java.lang.Object
  extended by org.compass.core.mapping.internal.DefaultAllMapping
All Implemented Interfaces:
AllMapping, InternalAllMapping

public class DefaultAllMapping
extends Object
implements InternalAllMapping

A set of settings configuring the all mapping.

Author:
kimchy

Constructor Summary
DefaultAllMapping()
           
 
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 isOmitTf()
           
 Boolean isSupported()
          Returns true if the "all" property will be created for the resource.
 void setExcludeAlias(Boolean excludeAlias)
           
 void setIncludePropertiesWithNoMappings(Boolean includePropertiesWithNoMappings)
           
 void setOmitNorms(Boolean omitNorms)
           
 void setOmitTf(Boolean omitTf)
           
 void setProperty(String property)
           
 void setSpellCheck(SpellCheckType spellCheck)
           
 void setSupported(Boolean supported)
           
 void setTermVector(Property.TermVector termVector)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultAllMapping

public DefaultAllMapping()
Method Detail

copy

public AllMapping copy()
Description copied from interface: AllMapping
Returns a copy of the All mapping settings.

Specified by:
copy in interface AllMapping

isSupported

public Boolean isSupported()
Description copied from interface: AllMapping
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.

Specified by:
isSupported in interface AllMapping

setSupported

public void setSupported(Boolean supported)
Specified by:
setSupported in interface InternalAllMapping

isExcludeAlias

public Boolean isExcludeAlias()
Description copied from interface: AllMapping
Should the alias be excluded from the "all" property. Default should be false.

Specified by:
isExcludeAlias in interface AllMapping

setExcludeAlias

public void setExcludeAlias(Boolean excludeAlias)
Specified by:
setExcludeAlias in interface InternalAllMapping

getProperty

public String getProperty()
Description copied from interface: AllMapping
Returns the name of the all property for the given resoruce.

Specified by:
getProperty in interface AllMapping

setProperty

public void setProperty(String property)
Specified by:
setProperty in interface InternalAllMapping

getTermVector

public Property.TermVector getTermVector()
Description copied from interface: AllMapping
Returns the term vector configuration for the given all proeprty.

Specified by:
getTermVector in interface AllMapping

setTermVector

public void setTermVector(Property.TermVector termVector)
Specified by:
setTermVector in interface InternalAllMapping

isOmitNorms

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

Specified by:
isOmitNorms in interface AllMapping

setOmitNorms

public void setOmitNorms(Boolean omitNorms)
Specified by:
setOmitNorms in interface InternalAllMapping

isOmitTf

public Boolean isOmitTf()
Specified by:
isOmitTf in interface AllMapping

setOmitTf

public void setOmitTf(Boolean omitTf)
Specified by:
setOmitTf in interface InternalAllMapping

isIncludePropertiesWithNoMappings

public Boolean isIncludePropertiesWithNoMappings()
Description copied from interface: AllMapping
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.

Specified by:
isIncludePropertiesWithNoMappings in interface AllMapping

setIncludePropertiesWithNoMappings

public void setIncludePropertiesWithNoMappings(Boolean includePropertiesWithNoMappings)
Specified by:
setIncludePropertiesWithNoMappings in interface InternalAllMapping

getSpellCheck

public SpellCheckType getSpellCheck()
Specified by:
getSpellCheck in interface AllMapping

setSpellCheck

public void setSpellCheck(SpellCheckType spellCheck)
Specified by:
setSpellCheck in interface InternalAllMapping


Copyright (c) 2004-2008 The Compass Project.