com.raritantechnologies.dieselpoint.openpipeline
Class RTIOpenPipelineConnector

java.lang.Object
  com.raritantechnologies.dieselpoint.openpipeline.RTIOpenPipelineConnector

All Implemented Interfaces:

IGatewayListener

public class RTIOpenPipelineConnector

extends java.lang.Object

implements IGatewayListener

Enables a Raritan ICollectionGateway to be plugged into an OpenPipeline data processing pipeline.

The OpenPipeline configuration maps to a Raritan Framework Configuration File:

Open Pipeline configuration File format:

  <connector>
    <short-name>[ name of RTI gateway in Raritan configuration XML ]</short-name>
    <display-name>[ name of Connector in display ]</display-name>
    <page-name>[ name of Connector UI page ]</page-name>
    <log-link>[ the Log Link ]</log-link>

    <!-- Input parameters to the collection gateway (if any ) -->
    <params>
      <param>
        <name>[ param name ]</param>
        <value>[ param value ]</param>
      </param>
    </params>

    <stages>
      <stage>
        <classname>[Name of Stage Class]

        <!-- RTIOpenPipelineStage needs a type and name that map to the         -->
        <!-- SystemObject type and name attributes in the RTI Configuration XML -->
        <type>[ type of stage e.g. "FieldFormatter" ]</type>
        <name>[ name of RTI SystemObject ]</name>

      </stage>
    </stages>

  </connector>
 

Constructor Summary

RTIOpenPipelineConnector()

Method Summary

void	dataComplete(java.lang.Object gateway) Message sent by ICollectionGateway after the last IResultSet has been submitted for processing.
void	execute()
void	gatewayFailed(java.lang.String message)
java.lang.String	getDescription()
java.lang.String	getDisplayName()
java.lang.String	getLogLink()
java.lang.String	getPageName()
java.lang.String	getShortName()
java.lang.String	getStatus()
int	getStatusCode()
void	interrupt() Interrupt the execution of this connector.
void	processData(IResultSet dataSet) Command to process a set of results generated by an ICollectionGateway implementation.
void	setCollectionGateway(ICollectionGateway collGateway)
void	setNextStage(Stage stage)
void	setParams(XMLConfig params) Sets the configuration parameters on the Connector.

Methods inherited from class java.lang.Object

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

Constructor Detail

RTIOpenPipelineConnector

public RTIOpenPipelineConnector()

Method Detail

setCollectionGateway

public void setCollectionGateway(ICollectionGateway collGateway)

execute

public void execute()

setNextStage

public void setNextStage(Stage stage)

interrupt

public void interrupt()

Interrupt the execution of this connector.

setParams

public void setParams(XMLConfig params)

Sets the configuration parameters on the Connector. The RTIOpenPipelineConnector wraps a configurable RTI ICollectionGateway. This object is configured in a separate XML file that is referenced by a Config.properties file which must be somewhere in the JVM Classpath.

getStatus

public java.lang.String getStatus()

getStatusCode

public int getStatusCode()

getDisplayName

public java.lang.String getDisplayName()

getShortName

public java.lang.String getShortName()

getDescription

public java.lang.String getDescription()

getPageName

public java.lang.String getPageName()

getLogLink

public java.lang.String getLogLink()

processData

public void processData(IResultSet dataSet)

Description copied from interface: IGatewayListener

Command to process a set of results generated by an ICollectionGateway implementation.

Specified by:

processData in interface IGatewayListener

dataComplete

public void dataComplete(java.lang.Object gateway)

Description copied from interface: IGatewayListener

Message sent by ICollectionGateway after the last IResultSet has been submitted for processing.

Specified by:

dataComplete in interface IGatewayListener

gatewayFailed

public void gatewayFailed(java.lang.String message)

Specified by:

gatewayFailed in interface IGatewayListener