com.attivio.sdk.search.relevancy

Class PhraseBoostFeature

java.lang.Object

com.attivio.sdk.search.relevancy.RelevancyFeatureDef

com.attivio.sdk.search.relevancy.PhraseBoostFeature

All Implemented Interfaces:

Serializable, Cloneable, Iterable<PhraseBoostFeature.ScopeBoost>

public class PhraseBoostFeature
extends RelevancyFeatureDef
implements Iterable<PhraseBoostFeature.ScopeBoost>

Relevancy feature that extracts phrase queries from the user query.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PhraseBoostFeature.ScopeBoost Experimental boost for phrases that match in specified scopes.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DISTANCE
static int	DEFAULT_MINIMUM
static boolean	DEFAULT_ORDERED
protected static ScoreMode	DEFAULT_SCORE_MODE

Constructor Summary

Constructors

Constructor and Description
PhraseBoostFeature(String name)

Method Summary

Modifier and Type	Method and Description
void	addScopeBoost(PhraseBoostFeature.ScopeBoost value) Add a scope boost.
PhraseBoostFeature	clone()
boolean	equals(Object other)
int	getDistance()
String	getField()
int	getMinimum()
String	getScope()
List<PhraseBoostFeature.ScopeBoost>	getScopeBoosts() Get all scope boosts.
ScoreMode	getScoreMode()
Set<String>	getSourceFields()
FieldExpression	getWeight()
int	hashCode()
boolean	isCompleteness()
boolean	isExactMatch() Deprecated.
boolean	isOrdered()
Iterator<PhraseBoostFeature.ScopeBoost>	iterator()
void	setCompleteness(boolean value)
void	setDistance(int value)
void	setExactMatch(boolean value) Deprecated.
void	setField(String value)
void	setMinimum(int value)
void	setOrdered(boolean value)
void	setScope(String value)
void	setScopeBoosts(List<PhraseBoostFeature.ScopeBoost> value) Set the scope boosts.
void	setScoreMode(ScoreMode value)
void	setSourceFields(Set<String> value)
void	setSourceFields(String... value)
void	setWeight(FieldExpression value)
String	toString()

Methods inherited from class com.attivio.sdk.search.relevancy.RelevancyFeatureDef

getName, setName

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

DEFAULT_MINIMUM

public static final int DEFAULT_MINIMUM

See Also:

Constant Field Values

DEFAULT_DISTANCE

public static final int DEFAULT_DISTANCE

See Also:

Constant Field Values

DEFAULT_ORDERED

public static final boolean DEFAULT_ORDERED

See Also:

Constant Field Values

DEFAULT_SCORE_MODE

protected static final ScoreMode DEFAULT_SCORE_MODE

Constructor Detail

PhraseBoostFeature

public PhraseBoostFeature(String name)

Method Detail

getScope

public String getScope()

setScope

public void setScope(String value)

getMinimum

public int getMinimum()

setMinimum

public void setMinimum(int value)

getDistance

public int getDistance()

setDistance

public void setDistance(int value)

isOrdered

public boolean isOrdered()

setOrdered

public void setOrdered(boolean value)

isCompleteness

public boolean isCompleteness()

setCompleteness

public void setCompleteness(boolean value)

isExactMatch

@Deprecated
public boolean isExactMatch()

Deprecated.

setExactMatch

@Deprecated
public void setExactMatch(boolean value)

Deprecated.

addScopeBoost

public void addScopeBoost(PhraseBoostFeature.ScopeBoost value)

Add a scope boost.

EXPERIMENTAL: Scope boosts are currently experimental and may change and/or be removed in the future.

getScopeBoosts

public List<PhraseBoostFeature.ScopeBoost> getScopeBoosts()

Get all scope boosts.

EXPERIMENTAL: Scope boosts are currently experimental and may change and/or be removed in the future.

setScopeBoosts

public void setScopeBoosts(List<PhraseBoostFeature.ScopeBoost> value)

Set the scope boosts.

EXPERIMENTAL: Scope boosts are currently experimental and may change and/or be removed in the future.

iterator

public Iterator<PhraseBoostFeature.ScopeBoost> iterator()

Specified by:

iterator in interface Iterable<PhraseBoostFeature.ScopeBoost>

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

equals

public boolean equals(Object other)

clone

public PhraseBoostFeature clone()

getField

public String getField()

setField

public void setField(String value)

getWeight

public FieldExpression getWeight()

setWeight

public void setWeight(FieldExpression value)

getSourceFields

public Set<String> getSourceFields()

setSourceFields

public void setSourceFields(Set<String> value)

setSourceFields

public void setSourceFields(String... value)

getScoreMode

public ScoreMode getScoreMode()

setScoreMode

public void setScoreMode(ScoreMode value)