Package com.inductiveautomation.historian.gateway.api.query

Interface ResultPublisher<K>

All Known Subinterfaces:

AnnotationPublisher, MetadataPublisher, ValuePublisher

All Known Implementing Classes:

DefaultAnnotationPublisher, DefaultMetadataPublisher, HistorianQueryExecutor

public interface ResultPublisher<K>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ResultPublisher.PublisherState	Enum representing the possible states of the publisher.

Method Summary

Modifier and Type	Method	Description
void	cancel()	Cancels the publishing process.
void	finish()	Completes the publishing process.
void	finishWithError(Exception e)	Completes the publishing process with an error.
String	getIdentifier()	Returns an identifier for this publisher.
ResultPublisher.PublisherState	getState()	Returns the current state of the publisher.
void	initializeWithFailure(K key, QualityCode qualityCode)	Initializes the publisher with a key and a quality code.

Method Details

getIdentifier

String getIdentifier()

Returns an identifier for this publisher.

Returns:

A String identifying this publisher instance

getState

ResultPublisher.PublisherState getState()

Returns the current state of the publisher.

Returns:

The current PublisherState

initializeWithFailure

void initializeWithFailure(K key,
 QualityCode qualityCode)

Initializes the publisher with a key and a quality code.

Parameters:

key - The key to initialize with

qualityCode - The quality code to initialize with

cancel

void cancel()

Cancels the publishing process. Must be called if the publishing process is canceled before completion.

finish

void finish()

Completes the publishing process. Must be called after everything's been published.

finishWithError

void finishWithError(Exception e)

Completes the publishing process with an error. Must be called if an error occurs during the publishing process.

Parameters:

e - The exception that caused the error.