com.groupbyinc.api.model

Class NumericBoost

java.lang.Object

com.groupbyinc.api.model.NumericBoost

public class NumericBoost
extends java.lang.Object

A numeric boost specifies a field to match in a search and a weight to apply to that field. The position of records in the page of results is adjusted by the value of the field multiplied by the weight.

Author:

groupby

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_STRENGTH

Constructor Summary

Constructors

Constructor and Description
NumericBoost()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName()
double	getStrength()
boolean	isInverted()
NumericBoost	setInverted(boolean inverted) Set whether the numeric boost is inverted
NumericBoost	setName(java.lang.String name) Set the name of the field to boost on
NumericBoost	setStrength(double strength) Set the weight of the numeric boost

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_STRENGTH

public static final double DEFAULT_STRENGTH

See Also:

Constant Field Values

Constructor Detail

NumericBoost

public NumericBoost()

Method Detail

getName

public java.lang.String getName()

Returns:

The name of the field to boost on

setName

public NumericBoost setName(java.lang.String name)

Set the name of the field to boost on

Parameters:

name - The name of the field to boost on

Returns:

isInverted

public boolean isInverted()

Returns:

Whether the numeric boost is inverted

setInverted

public NumericBoost setInverted(boolean inverted)

Set whether the numeric boost is inverted

Parameters:

inverted - if true, the numeric boost will be inverted

Returns:

getStrength

public double getStrength()

Returns:

The weight of the numeric boost

setStrength

public NumericBoost setStrength(double strength)

Set the weight of the numeric boost

Parameters:

strength - The weight of the numeric boost

Returns: