Package com.attivio.sdk.client

Interface SignalTrackingApi

All Superinterfaces:

ExposedApi

All Known Implementing Classes:

MockSignalTrackingService

public interface SignalTrackingApi
extends ExposedApi

API for interacting tracking signals in the system.

Method Summary

Modifier and Type	Method	Description
void	addSignal(Signal signal)	Add a signal
void	deleteSignals(java.lang.String signalType)	Delete all signals for signalType.
java.util.List<java.lang.String>	getAllRelevancyModelNames()	Get the names of all relevancy models across all signals
java.util.Map<java.lang.Long,java.lang.Long>	getModelHistogram(java.lang.String relevancyModelName, long relevancyModelVersion)	Get histogram data for a relevancy model
CloseableIterable<Signal>	getSignals(java.lang.String modelName, java.util.Date startTime, java.util.Date endTime, java.util.Set<java.lang.String> signalTypes)	Get all signals currently being tracked
java.util.List<java.lang.String>	getSignalTypes()	Get all available signal types.
void	importSignals(java.lang.Iterable<Signal> signals)	Import signals to be tracked

Method Detail

getAllRelevancyModelNames

java.util.List<java.lang.String> getAllRelevancyModelNames()

Get the names of all relevancy models across all signals

Returns:

relevancy model names

getModelHistogram

java.util.Map<java.lang.Long,java.lang.Long> getModelHistogram(java.lang.String relevancyModelName,
                                                                     long relevancyModelVersion)

Get histogram data for a relevancy model

Parameters:

relevancyModelName -

relevancyModelVersion -

Returns:

a map of the document ordinal to the number of signals associated therewith

addSignal

void addSignal(Signal signal)
        throws AttivioException

Add a signal

Parameters:

signal -

Throws:

AttivioException

getSignals

CloseableIterable<Signal> getSignals(java.lang.String modelName,
                                     java.util.Date startTime,
                                     java.util.Date endTime,
                                     java.util.Set<java.lang.String> signalTypes)

Get all signals currently being tracked

Parameters:

modelName - if not null, filter out signals not a part of this relevancy model

startTime - if not null, filter out signals for queries made earlier than this

endTime - if not null, filter out signals for queries made later than this

signalTypes - if not null, filter out signals of these types

Returns:

signals

importSignals

void importSignals(java.lang.Iterable<Signal> signals)
            throws AttivioException

Import signals to be tracked

Throws:

AttivioException

getSignalTypes

java.util.List<java.lang.String> getSignalTypes()
                                         throws AttivioException

Get all available signal types.

Throws:

AttivioException

deleteSignals

void deleteSignals(java.lang.String signalType)
            throws AttivioException

Delete all signals for signalType.

EXPERIMENTAL: the signature for this method may change/be removed in a future release without notice.

Throws:

AttivioException