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

Method Detail

getAllRelevancyModelNames

List<String> getAllRelevancyModelNames()

Get the names of all relevancy models across all signals

Returns:

relevancy model names

getModelHistogram

Map<Long,Long> getModelHistogram(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(String modelName,
                                     Date startTime,
                                     Date endTime,
                                     Set<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(Iterable<Signal> signals)
            throws AttivioException

Import signals to be tracked

Throws:

AttivioException

getSignalTypes

List<String> getSignalTypes()
                     throws AttivioException

Get all available signal types.

Throws:

AttivioException

deleteSignals

void deleteSignals(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