org.embulk.spi

Interface DecoderPlugin

public interface DecoderPlugin

The main class that a Decoder Plugin implements.

A Decoder Plugin converts a set of byte buffers in FileInput to another set of byte buffers of FileInput.

Since:

0.4.0

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
org.embulk.spi.FileInput	open(org.embulk.config.TaskSource taskSource, org.embulk.spi.FileInput fileInput) Opens a FileInput instance that receives Buffers from a File Input Plugin, or another Decoder Plugin, so that decoded input is read from a Parser Plugin, or another Decoder Plugin
void	transaction(org.embulk.config.ConfigSource config, DecoderPlugin.Control control) Processes the entire decoding transaction.

Method Detail

transaction

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

Processes the entire decoding transaction.

Parameters:

config - a configuration for the Decoder 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.FileInput open(org.embulk.config.TaskSource taskSource,
                              org.embulk.spi.FileInput fileInput)

Opens a FileInput instance that receives Buffers from a File Input Plugin, or another Decoder Plugin, so that decoded input is read from a Parser Plugin, or another Decoder Plugin

It processes each decoding task.

Parameters:

taskSource - a configuration processed for the task from ConfigSource

fileInput - FileInput to read byte buffers from a File Input Plugin, or another Decoder Plugin

Returns:

an implementation of FileInput that receives Buffers from a File Input Plugin, or another Decoder Plugin, so that decoded input is read from a Parser Plugin, or another Decoder Plugin

Since:

0.4.0