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

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

public class ResourceBoostMappingBuilder
extends Object

Allows to dynamically define the boost value of the resource based on a resource property value.

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

Field Summary
(package private)  RawBoostPropertyMapping mapping
           
 
Constructor Summary
ResourceBoostMappingBuilder(String name)
          Constructs a new boost resource property mapping.
 
Method Summary
 ResourceBoostMappingBuilder converter(Converter converter)
          Sets an actual converter that will be used to convert this property value.
 ResourceBoostMappingBuilder converter(ResourcePropertyConverter converter)
          Sets an actual converter that will be used to convert this property value.
 ResourceBoostMappingBuilder converter(String converterName)
          Sets the lookup converter name (registered with Compass) that will be used to convert the value of the property.
 ResourceBoostMappingBuilder defaultBoost(float defaultBoost)
          The default boost value that will be used of the resrouce property to be used has null value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

mapping

final RawBoostPropertyMapping mapping
Constructor Detail

ResourceBoostMappingBuilder

public ResourceBoostMappingBuilder(String name)
Constructs a new boost resource property mapping.

Method Detail

defaultBoost

public ResourceBoostMappingBuilder defaultBoost(float defaultBoost)
The default boost value that will be used of the resrouce property to be used has null value. Defaults to 1.0f.


converter

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


converter

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


converter

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



Copyright (c) 2004-2009 The Compass Project.