org.embulk.spi

Interface FormatterPlugin

public interface FormatterPlugin

The main class that a Formatter Plugin implements.

A Formatter Plugin formats a sequence of data records in PageOutput from an Input Plugin, or a Filter Plugin, into a set of byte buffers of FileOutput for a File Output Plugin, or an Encoder Plugin.

Since:

0.4.0

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
PageOutput	open(TaskSource taskSource, Schema schema, FileOutput output) Opens a PageOutput instance that receives Pages from an Input Plugin, or a Filter Plugin, and writes formatted output into FileOutput output in the parameter list for a File Output Plugin, or an Encoder Plugin.
void	transaction(ConfigSource config, Schema schema, FormatterPlugin.Control control) Processes the entire formatting transaction.

Method Detail

transaction

void transaction(ConfigSource config,
                 Schema schema,
                 FormatterPlugin.Control control)

Processes the entire formatting transaction.

Parameters:

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

schema - Schema of the input for the formatter

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

Since:

0.4.0

open

PageOutput open(TaskSource taskSource,
                Schema schema,
                FileOutput output)

Opens a PageOutput instance that receives Pages from an Input Plugin, or a Filter Plugin, and writes formatted output into FileOutput output in the parameter list for a File Output Plugin, or an Encoder Plugin.

It processes each formatting task.

Parameters:

taskSource - a configuration processed for the task from ConfigSource

schema - Schema of the input for the formatter

output - FileOutput to write formatted output so that the output is read from a File Output Plugin, or an Encoder Plugin

Returns:

an implementation of PageOutput that receives Pages from an Input Plugin, or a Filter Plugin, and writes formatted output into FileOutput output in the parameter list for a File Output Plugin, or an Encoder Plugin

Since:

0.4.0