org.compass.core.mapping.xsem.builder
Class XmlAllMappingBuilder

java.lang.Object
  extended by org.compass.core.mapping.xsem.builder.XmlAllMappingBuilder

public class XmlAllMappingBuilder
extends Object

A builder allowing to constrcut xml all mapping definition.

Author:
kimchy
See Also:
XSEM.all()

Field Summary
(package private)  DefaultAllMapping mapping
           
 
Constructor Summary
XmlAllMappingBuilder()
          Constructs a new all mapping builder.
 
Method Summary
 XmlAllMappingBuilder enable(boolean enable)
          Should the all mapping be enabled or not.
 XmlAllMappingBuilder excludeAlias(boolean excludeAlias)
          Should the alias be exlcuded from the all mapping or not.
 XmlAllMappingBuilder includePropertiesWithNoMappings(boolean includePropertiesWithNoMappings)
          Should the all mapping include properties that do not have mappings.
 XmlAllMappingBuilder omitNorms(boolean omitNorms)
          The omit norms of the all property.
 XmlAllMappingBuilder omitTf(boolean omitTf)
          The omit tf of the all property.
 XmlAllMappingBuilder spellCheck(SpellCheck spellCheck)
          The spell check type of the all property.
 XmlAllMappingBuilder termVector(Property.TermVector termVector)
          The term vector of the all property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

mapping

final DefaultAllMapping mapping
Constructor Detail

XmlAllMappingBuilder

public XmlAllMappingBuilder()
Constructs a new all mapping builder.

Method Detail

enable

public XmlAllMappingBuilder enable(boolean enable)
Should the all mapping be enabled or not. Defaults to the global CompassEnvironment.All.ENABLED setting which in turn defaults to true.


excludeAlias

public XmlAllMappingBuilder excludeAlias(boolean excludeAlias)
Should the alias be exlcuded from the all mapping or not. Default to the CompassEnvironment.All.EXCLUDE_ALIAS setting which in turn defaults to true.


includePropertiesWithNoMappings

public XmlAllMappingBuilder includePropertiesWithNoMappings(boolean includePropertiesWithNoMappings)
Should the all mapping include properties that do not have mappings. Defaults to the global CompassEnvironment.All.INCLUDE_UNMAPPED_PROPERTIES setting which in turn defaults to true.


termVector

public XmlAllMappingBuilder termVector(Property.TermVector termVector)
The term vector of the all property. Default to the CompassEnvironment.All.TERM_VECTOR setting which in turn defaults to NO.


omitNorms

public XmlAllMappingBuilder omitNorms(boolean omitNorms)
The omit norms of the all property. Default to the CompassEnvironment.All.OMIT_NORMS setting which in turn defaults to false.


omitTf

public XmlAllMappingBuilder omitTf(boolean omitTf)
The omit tf of the all property. Default to the CompassEnvironment.All.OMIT_TF setting which in turn defaults to false.


spellCheck

public XmlAllMappingBuilder spellCheck(SpellCheck spellCheck)
The spell check type of the all property.



Copyright (c) 2004-2009 The Compass Project.