org.eclipse.scada.da.server.exec.extractor

Class AbstractBaseExtractor

java.lang.Object

org.eclipse.scada.da.server.exec.extractor.AbstractBaseExtractor

All Implemented Interfaces:

Extractor

Direct Known Subclasses:

AbstractArrayExtractor, AbstractReturnCodeExtractor, PlainStreamExtractor

public abstract class AbstractBaseExtractor
extends java.lang.Object
implements Extractor

The AbstractBaseExtractor class implements most of the stuff you need in order to implement a full extractor. Handling of item factory, error handling and destruction (unregistering) are handled for you.

Constructor Summary

Constructors

Constructor and Description
AbstractBaseExtractor(java.lang.String id)

Method Summary

Methods

Modifier and Type	Method and Description
protected DataItemInputChained	createInput(java.lang.String localId)
protected abstract void	doProcess(ExecutionResult result) Process the execution result as input.
protected void	fillNoError(java.util.Map<java.lang.String,Variant> attributes)
void	process(ExecutionResult result)
void	register(Hive hive, FolderItemFactory folderItemFactory)
protected void	setError(java.lang.Throwable executionError, java.lang.String which) Set the error flags
void	unregister()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBaseExtractor

public AbstractBaseExtractor(java.lang.String id)

Method Detail

createInput

protected DataItemInputChained createInput(java.lang.String localId)

process

public void process(ExecutionResult result)

Specified by:

process in interface Extractor

setError

protected void setError(java.lang.Throwable executionError,
            java.lang.String which)

Set the error flags

Parameters:

executionError - the error that occurred

fillNoError

protected void fillNoError(java.util.Map<java.lang.String,Variant> attributes)

doProcess

protected abstract void doProcess(ExecutionResult result)
                           throws java.lang.Exception

Process the execution result as input.

This method will only be called if no execution error occurred. Otherwise the error flags of all data items are automatically set.

This method must apply the attributes from fillNoError(Map) when updating items. This is needed since applying them afterwards would cause two updates on the dataitem and the state would by async to the value itself.

Parameters:

result - the execution result that has to be processes

Throws:

java.lang.Exception - if anything goes wrong

register

public void register(Hive hive,
            FolderItemFactory folderItemFactory)

Specified by:

register in interface Extractor

unregister

public void unregister()

Specified by:

unregister in interface Extractor