quarks.oplet

Interface Oplet<I,O>

Type Parameters:

I - Data container type for input tuples.

O - Data container type for output tuples.

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

AbstractOplet, Aggregate, CounterOp, Events, FanOut, Filter, FlatMap, Isolate, Map, Peek, Peek, PeriodicSource, Pipe, PressureReliever, ProcessSource, Publish, RateMeter, SingleMetricAbstractOplet, Sink, Source, Split, SupplierPeriodicSource, SupplierSource, Union, UnorderedIsolate

public interface Oplet<I,O>
extends java.lang.AutoCloseable

Generic API for an oplet that processes streaming data on 0-N input ports and produces 0-M output streams on its output ports. An input port may be connected with any number of streams from other oplets. An output port may connected to any number of input ports on other oplets.

Method Summary

Modifier and Type	Method and Description
java.util.List<? extends Consumer<I>>	getInputs() Get the input stream data handlers for this oplet.
void	initialize(OpletContext<I,O> context) Initialize the oplet.
void	start() Start the oplet.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

initialize

void initialize(OpletContext<I,O> context)
         throws java.lang.Exception

Initialize the oplet.

Parameters:

context -

Throws:

java.lang.Exception

start

void start()

Start the oplet. Oplets must not submit any tuples not derived from input tuples until this method is called.

getInputs

java.util.List<? extends Consumer<I>> getInputs()

Get the input stream data handlers for this oplet. The number of handlers must equal the number of configured input ports. Each tuple arriving on an input port will be sent to the stream handler for that input port.

Returns:

list of consumers