org.compass.core.mapping.rsem.builder
Class ResourceIdMappingBuilder

java.lang.Object
  extended by org.compass.core.mapping.rsem.builder.ResourceIdMappingBuilder

public class ResourceIdMappingBuilder
extends Object

A builder allowing to constrcut resource id mapping definition.

Author:
kimchy
See Also:
RSEM.id(String)

Field Summary
(package private)  RawResourcePropertyIdMapping mapping
           
 
Constructor Summary
ResourceIdMappingBuilder(String name)
          Constructs a new resource id mapping builder for the specified name.
 
Method Summary
 ResourceIdMappingBuilder analyzer(String analyzer)
          Sets the analyzer logical name that will be used to analyzer the property value.
 ResourceIdMappingBuilder boost(float boost)
          Sets the boost value for the id property mapping.
 ResourceIdMappingBuilder converter(Converter converter)
          Sets an actual converter that will be used to convert this property value.
 ResourceIdMappingBuilder converter(ResourcePropertyConverter converter)
          Sets an actual converter that will be used to convert this property value.
 ResourceIdMappingBuilder converter(String converterName)
          Sets the lookup converter name (registered with Compass) that will be used to convert the value of the property.
 ResourceIdMappingBuilder excludeFromAll(ExcludeFromAll excludeFromAll)
          Controls if the id property will be excluded from all or not.
 ResourceIdMappingBuilder format(String format)
          Sets the format that will be used for formattable capable converters (such as numbers and dates).
 ResourceIdMappingBuilder omitNorms(boolean omitNorms)
          If set, omit normalization factors associated with this indexed field.
 ResourceIdMappingBuilder omitTf(boolean omitTf)
          If set, omit tf from postings of this indexed property.
 ResourceIdMappingBuilder spellCheck(SpellCheck spellCheck)
          Sets the spell check specific setting for the mapping.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

mapping

final RawResourcePropertyIdMapping mapping
Constructor Detail

ResourceIdMappingBuilder

public ResourceIdMappingBuilder(String name)
Constructs a new resource id mapping builder for the specified name.

Method Detail

analyzer

public ResourceIdMappingBuilder analyzer(String analyzer)
Sets the analyzer logical name that will be used to analyzer the property value. The name is a lookup name for an Analyzer that is registered with Compass.


omitNorms

public ResourceIdMappingBuilder omitNorms(boolean omitNorms)
If set, omit normalization factors associated with this indexed field. This effectively disables indexing boosts and length normalization for this field. By default, it is set for id mapping.


omitTf

public ResourceIdMappingBuilder omitTf(boolean omitTf)
If set, omit tf from postings of this indexed property. By default, it is set for id mapping.


boost

public ResourceIdMappingBuilder boost(float boost)
Sets the boost value for the id property mapping. Defaults to 1.0f.


format

public ResourceIdMappingBuilder format(String format)
Sets the format that will be used for formattable capable converters (such as numbers and dates).


converter

public ResourceIdMappingBuilder converter(String converterName)
Sets the lookup converter name (registered with Compass) that will be used to convert the value of the property.


converter

public ResourceIdMappingBuilder converter(Converter converter)
Sets an actual converter that will be used to convert this property value.


converter

public ResourceIdMappingBuilder converter(ResourcePropertyConverter converter)
Sets an actual converter that will be used to convert this property value.


excludeFromAll

public ResourceIdMappingBuilder excludeFromAll(ExcludeFromAll excludeFromAll)
Controls if the id property will be excluded from all or not.


spellCheck

public ResourceIdMappingBuilder spellCheck(SpellCheck spellCheck)
Sets the spell check specific setting for the mapping.



Copyright (c) 2004-2009 The Compass Project.