org.embulk.spi

Interface EncoderPlugin

public interface EncoderPlugin

The main class that an Encoder Plugin implements.

It converts a byte sequence FileOutput to another byte sequence FileOutput.

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) Processes each encoding task.
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

open

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

Processes each encoding task.

Parameters:

taskSource - a configuration processed for the task from ConfigSource

fileOutput - an output from a Formatter Plugin, or another Encoder Plugin

Returns:

an output for a File Output Plugin, or another Encoder Plugin