com.hazelcast.jet.processor

Interface ContainerProcessor<I,O>

Type Parameters:

I - Type of the input object

O - Type of the output object

All Superinterfaces:

Serializable

public interface ContainerProcessor<I,O>
extends Serializable

Abstract JET processor for application's execution Should be implemented by user and will be used during container's execution There are two phases of execution:

      1) Read phase. When Jet reads data from all input producers (previous vertices or taps) and
      can write or just collect somewhere input data

      2) Finalization phase. When JET uses results of Read-phase (if it presents) and can write or not
      data to the output stream
 

There is strict happens-before relation between execution of processor's execution. So no needs to use thread-safe structures in case if task created separate processor using corresponding factory

Method Summary

Modifier and Type	Method and Description
default void	afterProcessing(ProcessorContext processorContext) Will be invoked strictly after last invocation of the corresponding task, strictly from the executor thread
default void	beforeProcessing(ProcessorContext processorContext) Will be invoked strictly before first invocation of the corresponding task, strictly from the executor thread
default boolean	finalizeProcessor(ConsumerOutputStream<O> outputStream, ProcessorContext processorContext) Will be invoked on finalization phase
default boolean	process(ProducerInputStream<I> inputStream, ConsumerOutputStream<O> outputStream, String sourceName, ProcessorContext processorContext) Performs next iteration of execution

Method Detail

beforeProcessing

default void beforeProcessing(ProcessorContext processorContext)

Will be invoked strictly before first invocation of the corresponding task, strictly from the executor thread

Parameters:

processorContext - context of processor

process

default boolean process(ProducerInputStream<I> inputStream,
                        ConsumerOutputStream<O> outputStream,
                        String sourceName,
                        ProcessorContext processorContext)
                 throws Exception

Performs next iteration of execution

Parameters:

inputStream - stream to be used for reading of data

outputStream - steam to be used for writing of data

sourceName - name of the source where data come from (Vertex or Tap)

processorContext - context of processor

Returns:

true if next chunk should be read, false if next iteration will be with the same inputStream

Throws:

Exception - if any exception

finalizeProcessor

default boolean finalizeProcessor(ConsumerOutputStream<O> outputStream,
                                  ProcessorContext processorContext)
                           throws Exception

Will be invoked on finalization phase

Parameters:

outputStream - outputSteam where data should be written

processorContext - context of processor

Returns:

true if finalization is finished, false if this method should be invoked again

Throws:

Exception - if any exception

afterProcessing

default void afterProcessing(ProcessorContext processorContext)

Will be invoked strictly after last invocation of the corresponding task, strictly from the executor thread

Parameters:

processorContext - context of processor