Package com.attivio.sdk.search.relevancy

Class PhraseBoostFeature

java.lang.Object

com.attivio.sdk.search.relevancy.RelevancyFeatureDef

com.attivio.sdk.search.relevancy.QueryBoostFeature

com.attivio.sdk.search.relevancy.PhraseBoostFeature

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<PhraseBoostFeature.ScopeBoost>

public class PhraseBoostFeature
extends QueryBoostFeature
implements java.lang.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	Description
static class	PhraseBoostFeature.ScopeBoost	Experimental boost for phrases that match in specified scopes.

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_DISTANCE
static int	DEFAULT_MINIMUM
static boolean	DEFAULT_ORDERED

Fields inherited from class com.attivio.sdk.search.relevancy.QueryBoostFeature

DEFAULT_SCORE_MODE

Constructor Summary

Constructors

Constructor	Description
PhraseBoostFeature(java.lang.String name)

Method Summary

Modifier and Type	Method	Description
void	addScopeBoost(PhraseBoostFeature.ScopeBoost value)	Add a scope boost.
PhraseBoostFeature	clone()
boolean	equals(java.lang.Object other)
long	estimatedSize()
int	getDistance()
int	getMinimum()
java.lang.String	getScope()
java.util.List<PhraseBoostFeature.ScopeBoost>	getScopeBoosts()	Get all scope boosts.
int	hashCode()
boolean	isCompleteness()
boolean	isExactMatch()	Deprecated.
boolean	isOrdered()
java.util.Iterator<PhraseBoostFeature.ScopeBoost>	iterator()
void	setCompleteness(boolean value)
void	setDistance(int value)
void	setExactMatch(boolean value)	Deprecated.
void	setMinimum(int value)
void	setOrdered(boolean value)
void	setScope(java.lang.String value)
void	setScopeBoosts(java.util.List<PhraseBoostFeature.ScopeBoost> value)	Set the scope boosts.
java.lang.String	toString()

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

getField, getScoreMode, getSourceFields, getWeight, setField, setScoreMode, setSourceFields, setSourceFields, setWeight

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

Constructor Detail

PhraseBoostFeature

public PhraseBoostFeature(java.lang.String name)

Method Detail

getScope

public java.lang.String getScope()

setScope

public void setScope(java.lang.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 java.util.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(java.util.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 java.util.Iterator<PhraseBoostFeature.ScopeBoost> iterator()

Specified by:

iterator in interface java.lang.Iterable<PhraseBoostFeature.ScopeBoost>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class QueryBoostFeature

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class QueryBoostFeature

clone

public PhraseBoostFeature clone()

Overrides:

clone in class QueryBoostFeature

estimatedSize

public long estimatedSize()

Overrides:

estimatedSize in class QueryBoostFeature