org.embulk.spi

Interface ParserPlugin

public interface ParserPlugin

The main class that a Parser Plugin implements.

A Parser Plugin parses a set of byte buffers in FileInput from a File Input Plugin, or an Decoder Plugin, so that parsed input is read from an Output Plugin, or a Filter Plugin.

Since:

0.4.0

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
void	run(TaskSource taskSource, Schema schema, FileInput input, PageOutput output) Runs each parsing task.
void	transaction(ConfigSource config, ParserPlugin.Control control) Processes the entire parsing transaction.

Method Detail

transaction

void transaction(ConfigSource config,
                 ParserPlugin.Control control)

Processes the entire parsing transaction.

Parameters:

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

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

Since:

0.4.0

run

void run(TaskSource taskSource,
         Schema schema,
         FileInput input,
         PageOutput output)

Runs each parsing task.

Parameters:

taskSource - a configuration processed for the task from ConfigSource

schema - Schema to be parsed to

input - FileOutput that is read from a File Input Plugin, or a Decoder Plugin

output - PageOutput to write parsed input so that the input is read from an Output Plugin, or another Filter Plugin

Since:

0.4.0