Package com.inductiveautomation.historian.gateway.query

Class DefaultMetadataPublisher

java.lang.Object

com.inductiveautomation.historian.gateway.query.DefaultMetadataPublisher

All Implemented Interfaces:

MetadataPublisher, ResultPublisher<QualifiedPath>

public class DefaultMetadataPublisher
extends Object
implements MetadataPublisher

Nested Class Summary

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

ResultPublisher.PublisherState

Constructor Summary

Constructors

Constructor	Description
DefaultMetadataPublisher(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.
Exception	getError()
String	getIdentifier()	Returns an identifier for this publisher.
List<Metadata>	getMetadata()
Map<QualifiedPath,QualityCode>	getQualityCodes()
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(Metadata metadata)	Publishes metadata.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultMetadataPublisher

public DefaultMetadataPublisher(String publisherId)

Method Details

publish

public void publish(Metadata metadata)
             throws IllegalStateException

Description copied from interface: MetadataPublisher

Publishes metadata.

Specified by:

publish in interface MetadataPublisher

Parameters:

metadata - The metadata to publish.

Throws:

IllegalStateException - if the publisher is not in PUBLISHING state

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

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.

getMetadata

public List<Metadata> getMetadata()

getQualityCodes

public Map<QualifiedPath,QualityCode> getQualityCodes()

getError

public Exception getError()