org.apache.tez.runtime.api

Interface InputFrameworkInterface

All Known Subinterfaces:

LogicalInputFrameworkInterface

All Known Implementing Classes:

AbstractLogicalInput

@InterfaceAudience.Public
public interface InputFrameworkInterface

Represents an input through which a TezProcessor receives data on an edge.

This interface has methods which are used by the Tez framework to control the Input.

During initialization, Inputs must specify an initial memory requirement via InputContext.requestInitialMemory

Inputs must also inform the framework once they are ready to be consumed. This typically means that the Processor will not block when reading from the corresponding Input. This is done via InputContext.inputIsReady. Inputs choose the policy on when they are ready. Input implementations are expected to derive from AbstractLogicalInput

Method Summary

Modifier and Type	Method and Description
List<Event>	close() Closes the Input
void	handleEvents(List<Event> inputEvents) Handles user and system generated Events, which typically carry information such as an output being available on the previous vertex.
List<Event>	initialize() Initializes the Input.

Method Detail

initialize

List<Event> initialize()
                throws Exception

Initializes the Input.

Returns:

list of events that were generated during initialization

Throws:

Exception - if an error occurs

handleEvents

void handleEvents(List<Event> inputEvents)
           throws Exception

Handles user and system generated Events, which typically carry information such as an output being available on the previous vertex.

Parameters:

inputEvents - the list of Events

Throws:

Exception

close

List<Event> close()
           throws Exception

Closes the Input

Returns:

list of events that were generated during close

Throws:

Exception - if an error occurs