KeyAndBoost (pipeline-javadocs 5.10 API)

java.lang.Object
- com.lucidworks.search.dsl.DslBase
- - com.lucidworks.search.dsl.request.DslCloneable
  - - com.lucidworks.search.dsl.request.query.KeyAndBoost

public class KeyAndBoost
extends DslCloneable

A field value and boost value combination

- Constructor Summary
  
  Constructors
  Constructor Description
  
  KeyAndBoost(java.lang.String key, java.lang.Double boost)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  KeyAndBoost clone()
  
  java.lang.Double getBoost()
  
  java.lang.String getKey()
  - Methods inherited from class com.lucidworks.search.dsl.request.DslCloneable
    clone, deepClone
  - Methods inherited from class com.lucidworks.search.dsl.DslBase
    equals, hashCode, toString
  - Methods inherited from class java.lang.Object
    getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - KeyAndBoost
```
public KeyAndBoost(java.lang.String key,
                   java.lang.Double boost)
```
- Method Detail
  - getKey
```
public java.lang.String getKey()
```
    Returns:
    
    the field value being boosted
  - getBoost
```
public java.lang.Double getBoost()
```
    Returns:
    
    a boost to apply to matches to the getKey() field. Must be positive. Though fractional values are accepted for users looking to minimize the impact of particular fields.
  - clone
```
public KeyAndBoost clone()
```
    Specified by:
    
    clone in class DslCloneable