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

Class DefaultMetadataProcessor

java.lang.Object

com.inductiveautomation.historian.gateway.api.query.processor.DefaultMetadataProcessor

All Implemented Interfaces:

ComplexPointProcessor<MetadataPoint,MetadataQueryKey>, MetadataPointProcessor, QueriedPointProcessor<MetadataPoint,MetadataQueryKey,ComplexPointType>

public class DefaultMetadataProcessor
extends Object
implements MetadataPointProcessor

Default implementation of the MetadataPointProcessor interface.

This class processes metadata points and manages their associated quality codes. It provides methods for initialization, handling metadata points, and managing errors during the processing lifecycle.

Constructor Summary

Constructors

Constructor	Description
DefaultMetadataProcessor(List<MetadataQueryKey> keys, String identifier)	Constructs a new DefaultMetadataProcessor.

Method Summary

Modifier and Type	Method	Description
Results<MetadataPoint>	getResults()	Retrieves the results of the metadata processing.
void	onComplete()	Called when all processing is complete.
void	onError(QualityCode error)	Handles a terminal error condition with a quality code.
void	onError(Exception error)	Handles a terminal error condition with an exception.
boolean	onInitialize(ProcessingContext<MetadataQueryKey,ComplexPointType> context)	Initializes the processor with context information before processing begins.
void	onKeyFailure(MetadataQueryKey queryKey, QualityCode failureCode)	Handles a failure specific to a query key.
boolean	onPointAvailable(MetadataQueryKey queryKey, MetadataPoint point)	Processes a single temporal point.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultMetadataProcessor

public DefaultMetadataProcessor(List<MetadataQueryKey> keys,
 String identifier)

Constructs a new DefaultMetadataProcessor.

Initializes the quality codes for the provided metadata query keys and sets up the logger.

Parameters:

keys - A list of metadata query keys to initialize with a default quality code.

identifier - A unique identifier for the logger context.

Method Details

getResults

public Results<MetadataPoint> getResults()

Retrieves the results of the metadata processing.

If the result quality is good, returns the processed metadata points. Otherwise, returns an error result.

Returns:

A Results object containing the metadata points or an error.

onInitialize

public boolean onInitialize(ProcessingContext<MetadataQueryKey,ComplexPointType> context)

Description copied from interface: QueriedPointProcessor

Initializes the processor with context information before processing begins. This method is called once before any points are processed.

Specified by:

onInitialize in interface QueriedPointProcessor<MetadataPoint,MetadataQueryKey,ComplexPointType>

Parameters:

context - The processing context containing initialization properties.

Returns:

True if initialization was successful and processing should continue, false to stop.

onPointAvailable

public boolean onPointAvailable(MetadataQueryKey queryKey,
 MetadataPoint point)

Description copied from interface: QueriedPointProcessor

Processes a single temporal point. Called repeatedly for each point in the result set.

Specified by:

onPointAvailable in interface QueriedPointProcessor<MetadataPoint,MetadataQueryKey,ComplexPointType>

Parameters:

queryKey - The query key associated with the point.

point - The temporal point to process.

Returns:

True to continue processing additional points, false to stop.

onKeyFailure

public void onKeyFailure(MetadataQueryKey queryKey,
 QualityCode failureCode)

Description copied from interface: QueriedPointProcessor

Handles a failure specific to a query key. Processing continues for other query keys after this is called. This method can be called prior to QueriedPointProcessor.onInitialize(ProcessingContext) as needed.

Specified by:

onKeyFailure in interface QueriedPointProcessor<MetadataPoint,MetadataQueryKey,ComplexPointType>

Parameters:

queryKey - The query key that failed.

failureCode - The quality code indicating the reason for failure.

onError

public void onError(QualityCode error)

Description copied from interface: QueriedPointProcessor

Handles a terminal error condition with a quality code. Processing stops after this method is called.

Specified by:

onError in interface QueriedPointProcessor<MetadataPoint,MetadataQueryKey,ComplexPointType>

Parameters:

error - The quality code representing the error condition.

onError

public void onError(Exception error)

Description copied from interface: QueriedPointProcessor

Handles a terminal error condition with an exception. Processing stops after this method is called.

Specified by:

onError in interface QueriedPointProcessor<MetadataPoint,MetadataQueryKey,ComplexPointType>

Parameters:

error - The exception that caused the error.

onComplete

public void onComplete()

Description copied from interface: QueriedPointProcessor

Called when all processing is complete. This method is called exactly once after all points have been processed or processing has been stopped.

Specified by:

onComplete in interface QueriedPointProcessor<MetadataPoint,MetadataQueryKey,ComplexPointType>