FieldBooster (Vitro API 1.14.2 API)

java.lang.Object
- edu.cornell.mannlib.vitro.webapp.searchindex.documentBuilding.FieldBooster

All Implemented Interfaces:: DocumentModifier

public class FieldBooster
extends Object
implements DocumentModifier

Constructor Summary

Constructors
Constructor Description

FieldBooster()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addTargetField(String fieldName)`
`void`	`modifyDocument(Individual individual, SearchInputDocument doc)`	Use the rules contained within this class to modify this search document, according to the characteristics of this individual.
`void`	`setBoost(float boost)`
`void`	`shutdown()`	Called to inform the DocumentModifier that the system is shutting down.
`String`	`toString()`
`void`	`validate()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FieldBooster
```
public FieldBooster()
```
- Method Detail
  - addTargetField
```
public void addTargetField(String fieldName)
```
  - setBoost
```
public void setBoost(float boost)
```
  - validate
```
public void validate()
```
  - modifyDocument
```
public void modifyDocument(Individual individual,
                           SearchInputDocument doc)
```
    Description copied from interface: DocumentModifier
    
    Use the rules contained within this class to modify this search document, according to the characteristics of this individual.
    
    Specified by:
    
    modifyDocument in interface DocumentModifier
    
    Parameters:
    
    individual - The individual that is being indexed. Will not be null.
    
    doc - The document as it stands so far. Will not be null.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: DocumentModifier
    
    Called to inform the DocumentModifier that the system is shutting down.
    
    Specified by:
    
    shutdown in interface DocumentModifier
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object