org.embulk.spi

Interface EncoderPlugin

public interface EncoderPlugin

The main class that an Encoder Plugin implements.

An Encoder Plugin converts a set of byte buffers in FileOutput to another set of byte buffers of FileOutput.

Since:

0.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EncoderPlugin.Control A controller of the following tasks provided from the Embulk core.

Method Summary

Modifier and Type	Method and Description
org.embulk.spi.FileOutput	open(org.embulk.config.TaskSource taskSource, org.embulk.spi.FileOutput fileOutput) Opens a FileOutput instance that receives Buffers from a Formatter Plugin, or another Encoder Plugin, and writes encoded output into FileOutput fileOutput in the parameter list.
void	transaction(org.embulk.config.ConfigSource config, EncoderPlugin.Control control) Processes the entire encoding transaction.

Method Detail

transaction

void transaction(org.embulk.config.ConfigSource config,
                 EncoderPlugin.Control control)

Processes the entire encoding transaction.

Parameters:

config - a configuration for the Encoder Plugin given from a user

control - a controller of the following tasks provided from the Embulk core

Since:

0.4.0

open

org.embulk.spi.FileOutput open(org.embulk.config.TaskSource taskSource,
                               org.embulk.spi.FileOutput fileOutput)

Opens a FileOutput instance that receives Buffers from a Formatter Plugin, or another Encoder Plugin, and writes encoded output into FileOutput fileOutput in the parameter list.

Parameters:

taskSource - a configuration processed for the task from ConfigSource

fileOutput - FileOutput to write encoded output for a File Output Plugin, or another Encoder Plugin

Returns:

an implementation of FileOutput that receives Buffers from a Formatter Plugin, or another Encoder Plugin, and writes encoded output into FileOutput fileOutput in the parameter list

Since:

0.4.0