org.embulk.spi

Interface FilterPlugin

public interface FilterPlugin

The main class that a Filter Plugin implements.

A Filter Plugin converts a schema and a sequence of data records in PageOutput from an Input Plugin, or another Filter Plugin, into another schema and another sequence of data records in PageOutput for an Output Plugin, or another Filter Plugin.

Since:

0.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FilterPlugin.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 inputSchema, Schema outputSchema, PageOutput output) Opens a PageOutput instance that receives Pages from an Input Plugin, or another Filter Plugin, and writes converted output into PageOutput output in the parameter list for an Output Plugin, or another Filter Plugin.
void	transaction(ConfigSource config, Schema inputSchema, FilterPlugin.Control control) Processes the entire filtering transaction.

Method Detail

transaction

void transaction(ConfigSource config,
                 Schema inputSchema,
                 FilterPlugin.Control control)

Processes the entire filtering transaction.

Parameters:

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

inputSchema - Schema of the input for the filter

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

Since:

0.4.0

open

PageOutput open(TaskSource taskSource,
                Schema inputSchema,
                Schema outputSchema,
                PageOutput output)

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

Parameters:

taskSource - a configuration processed for the task from ConfigSource

inputSchema - Schema of the input for the filter

outputSchema - Schema of the output from the filter

output - PageOutput to write converted input for an Output Plugin, or another Filter Plugin

Returns:

an implementation of PageOutput that receives Pages from an Input Plugin, or another Filter Plugin, and writes converted output into PageOutput output in the parameter list for an Output Plugin, or another Filter Plugin

Since:

0.4.0