com.attivio.sdk.search.relevancy

Class Signal

java.lang.Object

com.attivio.sdk.search.relevancy.Signal

All Implemented Interfaces:

Serializable, Cloneable, Comparable

public class Signal
extends Object
implements Serializable, Cloneable, Comparable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Signal.SimpleSignalCompare Compares using type, query, docId, and principal.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLICK Signal type click that results from clicking a search result link
static String	RATING Signal type rating for that results from rating a search result

Constructor Summary

Constructors

Constructor and Description
Signal()

Method Summary

Modifier and Type	Method and Description
protected Signal	clone()
int	compareTo(Object o)
boolean	equals(Object obj)
String	getDocId()
long	getDocOrdinal()
RelevancyFeatureVector	getFeatureVector()
Locale	getLocale()
AttivioPrincipal	getPrincipal()
String	getQuery()
long	getQueryTimestamp()
String	getRelevancyModelName()
String[]	getRelevancyModelNames()
long	getRelevancyModelVersion()
static Signal	getSignal(QueryResponse queryResponse, int documentIndex) Create a click signal with a strength of one
static Signal	getSignal(QueryResponse queryResponse, int documentIndex, String signalType) Create a signal with a signal strength of one
static Signal	getSignal(QueryResponse queryResponse, int documentIndex, String signalType, double signalStrength) Create a signal
long	getSignalTimestamp()
String	getType()
double	getWeight()
int	hashCode()
boolean	isTTL() Get if TTL will be honored for this signal.
boolean	isValid()
static int	nullCompare(Comparable o1, Comparable o2)
void	setDocId(String docId)
void	setDocOrdinal(long docOrdinal)
void	setFeatureVector(RelevancyFeatureVector featureVector)
void	setLocale(Locale locale)
void	setPrincipal(AttivioPrincipal principal)
void	setQuery(String query)
void	setQueryTimestamp(long queryTimestamp)
void	setRelevancyModelName(String relevancyModelName)
void	setRelevancyModelNames(String... relevancyModelNames)
void	setRelevancyModelVersion(long relevancyModelVersion)
void	setSignalTimestamp(long signalTimestamp)
void	setTTL(boolean value) Get if TTL will be honored for this signal.
void	setType(String type)
void	setWeight(double weight)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CLICK

public static final String CLICK

Signal type click that results from clicking a search result link

See Also:

Constant Field Values

RATING

public static final String RATING

Signal type rating for that results from rating a search result

See Also:

Constant Field Values

Constructor Detail

Signal

public Signal()

Method Detail

getSignal

public static Signal getSignal(QueryResponse queryResponse,
                               int documentIndex,
                               String signalType,
                               double signalStrength)

Create a signal

Parameters:

queryResponse -

documentIndex - the index from the offset of the document to associate with the signal

signalType - the type of the signal (click, rate, screen time)

signalStrength - the strength of the signal

Returns:

a signal

getSignal

public static Signal getSignal(QueryResponse queryResponse,
                               int documentIndex,
                               String signalType)

Create a signal with a signal strength of one

Parameters:

queryResponse -

documentIndex - the index from the offset of the document to associate with the signal

signalType - the type of the signal (click, rate, screen time)

Returns:

a signal

getSignal

public static Signal getSignal(QueryResponse queryResponse,
                               int documentIndex)

Create a click signal with a strength of one

Parameters:

queryResponse -

documentIndex - the index from the offset of the document to associate with the signal

Returns:

a signal

getType

public String getType()

Returns:

the signalType

setType

public void setType(String type)

Parameters:

type - the signalType to set

getWeight

public double getWeight()

Returns:

the signal weight

isTTL

public boolean isTTL()

Get if TTL will be honored for this signal.

If this is false, then the signal will be persistent and will not be deleted automatically.

setTTL

public void setTTL(boolean value)

Get if TTL will be honored for this signal.

If this is false, then the signal will be persistent and will not be deleted automatically.

setWeight

public void setWeight(double weight)

Parameters:

weight - the signal weight to set

getRelevancyModelName

public String getRelevancyModelName()

Returns:

the relevancyModelName

setRelevancyModelName

public void setRelevancyModelName(String relevancyModelName)

Parameters:

relevancyModelName - the relevancyModelName to set

getRelevancyModelVersion

public long getRelevancyModelVersion()

Returns:

the relevancyModelVersion

setRelevancyModelVersion

public void setRelevancyModelVersion(long relevancyModelVersion)

Parameters:

relevancyModelVersion - the relevancyModelVersion to set

getQueryTimestamp

public long getQueryTimestamp()

Returns:

the queryTimestamp

setQueryTimestamp

public void setQueryTimestamp(long queryTimestamp)

Parameters:

queryTimestamp - the queryTimestamp to set

getSignalTimestamp

public long getSignalTimestamp()

Returns:

the signalTimestamp

setSignalTimestamp

public void setSignalTimestamp(long signalTimestamp)

Parameters:

signalTimestamp - the queryTimestamp to set

getFeatureVector

public RelevancyFeatureVector getFeatureVector()

Returns:

the featureVector

setFeatureVector

public void setFeatureVector(RelevancyFeatureVector featureVector)

Parameters:

featureVector - the featureVector to set

getPrincipal

public AttivioPrincipal getPrincipal()

Returns:

the principal

setPrincipal

public void setPrincipal(AttivioPrincipal principal)

Parameters:

principal - the principal to set

getDocId

public String getDocId()

Returns:

the docId

setDocId

public void setDocId(String docId)

Parameters:

docId - the docId to set

getDocOrdinal

public long getDocOrdinal()

Returns:

the docOrdinal

setDocOrdinal

public void setDocOrdinal(long docOrdinal)

Parameters:

docOrdinal - the docOrdinal to set

getQuery

public String getQuery()

Returns:

the query

setQuery

public void setQuery(String query)

Parameters:

query - the query to set

getLocale

public Locale getLocale()

Returns:

the locale

setLocale

public void setLocale(Locale locale)

Parameters:

locale - the locale to set

getRelevancyModelNames

public String[] getRelevancyModelNames()

Returns:

the relevancyModelNames

setRelevancyModelNames

public void setRelevancyModelNames(String... relevancyModelNames)

Parameters:

relevancyModelNames - the relevancyModelNames to set

isValid

public boolean isValid()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

clone

protected Signal clone()
                throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

nullCompare

public static int nullCompare(Comparable o1,
                              Comparable o2)

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable