Package com.inductiveautomation.historian.gateway.query

Class DefaultAnnotationPublisher

java.lang.Object

com.inductiveautomation.historian.gateway.query.DefaultAnnotationPublisher

All Implemented Interfaces:

AnnotationPublisher, ResultPublisher<QualifiedPath>

public class DefaultAnnotationPublisher
extends Object
implements AnnotationPublisher

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.historian.gateway.api.query.ResultPublisher

ResultPublisher.PublisherState

Constructor Summary

Constructors

Constructor	Description
DefaultAnnotationPublisher(String publisherId)

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.
List<Annotation>	getAnnotations()
Exception	getError()
String	getIdentifier()	Returns an identifier for this publisher.
Map<QualifiedPath,QualityCode>	getQualityCodeMap()
ResultPublisher.PublisherState	getState()	Returns the current state of the publisher.
void	initializeWithFailure(QualifiedPath key, QualityCode qualityCode)	Initializes the publisher with a key and a quality code.
void	publish(Annotation value)	Publishes an annotation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultAnnotationPublisher

public DefaultAnnotationPublisher(String publisherId)

Method Details

getIdentifier

public String getIdentifier()

Description copied from interface: ResultPublisher

Returns an identifier for this publisher.

Specified by:

getIdentifier in interface ResultPublisher<QualifiedPath>

Returns:

A String identifying this publisher instance

getState

public ResultPublisher.PublisherState getState()

Description copied from interface: ResultPublisher

Returns the current state of the publisher.

Specified by:

getState in interface ResultPublisher<QualifiedPath>

Returns:

The current PublisherState

initializeWithFailure

public void initializeWithFailure(QualifiedPath key,
 QualityCode qualityCode)

Description copied from interface: ResultPublisher

Initializes the publisher with a key and a quality code.

Specified by:

initializeWithFailure in interface ResultPublisher<QualifiedPath>

Parameters:

key - The key to initialize with

qualityCode - The quality code to initialize with

publish

public void publish(Annotation value)
             throws IllegalStateException

Description copied from interface: AnnotationPublisher

Publishes an annotation.

Specified by:

publish in interface AnnotationPublisher

Parameters:

value - The annotation to publish.

Throws:

IllegalStateException - if the publisher is not in PUBLISHING state

cancel

public void cancel()

Description copied from interface: ResultPublisher

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

Specified by:

cancel in interface ResultPublisher<QualifiedPath>

finish

public void finish()

Description copied from interface: ResultPublisher

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

Specified by:

finish in interface ResultPublisher<QualifiedPath>

finishWithError

public void finishWithError(Exception e)

Description copied from interface: ResultPublisher

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

Specified by:

finishWithError in interface ResultPublisher<QualifiedPath>

Parameters:

e - The exception that caused the error.

getQualityCodeMap

public Map<QualifiedPath,QualityCode> getQualityCodeMap()

getError

public Exception getError()

getAnnotations

public List<Annotation> getAnnotations()