PhraseBoostFeature.ScopeBoost (platform/sdk 5.6.3.0 API)

java.lang.Object
- com.attivio.sdk.search.relevancy.PhraseBoostFeature.ScopeBoost

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Enclosing class:

PhraseBoostFeature
```
public static final class PhraseBoostFeature.ScopeBoost
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
```
Experimental boost for phrases that match in specified scopes.
This boost will increase the weight of the frequency score for a match in a specified scope.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected int boost

protected int completeness

protected java.lang.String name

Constructor Summary

Constructors
Constructor	Description
`ScopeBoost(java.lang.String name, int boost)`
`ScopeBoost(java.lang.String name, int boost, int completeness)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PhraseBoostFeature.ScopeBoost`	`clone()`
`boolean`	`equals(java.lang.Object other)`
`long`	`estimatedSize()`
`int`	`getBoost()`	Get the boost value for this ScopeBoost.
`int`	`getCompleteness()`	Get the completeness boost value for this ScopeBoost.
`java.lang.String`	`getName()`	Get the scope name for this ScopeBoost.
`int`	`hashCode()`
`void`	`setBoost(int boost)`	Set the boost value for this ScopeBoost.
`void`	`setCompleteness(int completeness)`	Set the completeness boost value for this ScopeBoost.
`void`	`setName(java.lang.String name)`	Set the scope name for this ScopeBoost.
`java.lang.String`	`toString()`

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

Field Detail

name
```
protected java.lang.String name
```

boost
```
protected int boost
```

completeness
```
protected int completeness
```

Constructor Detail

ScopeBoost

public ScopeBoost(java.lang.String name,
                  int boost)

ScopeBoost

public ScopeBoost(java.lang.String name,
                  int boost,
                  int completeness)

Method Detail
- getName
```
public java.lang.String getName()
```
  Get the scope name for this ScopeBoost.
- setName
```
public void setName(java.lang.String name)
```
  Set the scope name for this ScopeBoost.
- getBoost
```
public int getBoost()
```
  Get the boost value for this ScopeBoost.
- setBoost
```
public void setBoost(int boost)
```
  Set the boost value for this ScopeBoost.
- getCompleteness
```
public int getCompleteness()
```
  Get the completeness boost value for this ScopeBoost.
- setCompleteness
```
public void setCompleteness(int completeness)
```
  Set the completeness boost value for this ScopeBoost.
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class java.lang.Object
- equals
```
public boolean equals(java.lang.Object other)
```
  Overrides:
  
  equals in class java.lang.Object
- clone
```
public PhraseBoostFeature.ScopeBoost clone()
```
  Overrides:
  
  clone in class java.lang.Object
- toString
```
public java.lang.String toString()
```
  Overrides:
  
  toString in class java.lang.Object
- estimatedSize
```
public long estimatedSize()
```