org.embulk.spi

Class PageBuilder

java.lang.Object

org.embulk.spi.PageBuilder

All Implemented Interfaces:

AutoCloseable

public class PageBuilder
extends Object
implements AutoCloseable

Builds Pages from Schema and data records with pushing the built Pages to PageOutput.

Since:

0.4.0

Constructor Summary

Constructors

Constructor and Description
PageBuilder(BufferAllocator allocator, Schema schema, PageOutput output) Deprecated. The constructor is deprecated although Embulk v0.9-compatible plugins still have to use this. See GitHub Issue #1321: Deprecate PageBuilder's constructor for the details.

Method Summary

Modifier and Type	Method and Description
void	addRecord()
void	close()
void	finish()
void	flush()
Schema	getSchema()
void	setBoolean(Column column, boolean value)
void	setBoolean(int columnIndex, boolean value)
void	setDouble(Column column, double value)
void	setDouble(int columnIndex, double value)
void	setJson(Column column, JsonValue value) Sets a JSON value at the specified column.
void	setJson(Column column, org.msgpack.value.Value value) Deprecated. Use setJson(org.embulk.spi.Column, org.embulk.spi.json.JsonValue) instead.
void	setJson(int columnIndex, JsonValue value) Sets a JSON value at the specified column.
void	setJson(int columnIndex, org.msgpack.value.Value value) Deprecated. Use setJson(int, org.embulk.spi.json.JsonValue) instead.
void	setLong(Column column, long value)
void	setLong(int columnIndex, long value)
void	setNull(Column column)
void	setNull(int columnIndex)
void	setString(Column column, String value)
void	setString(int columnIndex, String value)
void	setTimestamp(Column column, Instant value)
void	setTimestamp(Column column, Timestamp value) Deprecated.
void	setTimestamp(int columnIndex, Instant value)
void	setTimestamp(int columnIndex, Timestamp value) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PageBuilder

@Deprecated
public PageBuilder(BufferAllocator allocator,
                               Schema schema,
                               PageOutput output)

Deprecated. The constructor is deprecated although Embulk v0.9-compatible plugins still have to use this. See GitHub Issue #1321: Deprecate PageBuilder's constructor for the details.

Constructs a PageBuilder instance.

Since:

0.4.0

Method Detail

getSchema

public Schema getSchema()

Since:

0.4.0

setNull

public void setNull(Column column)

Since:

0.4.0

setNull

public void setNull(int columnIndex)

Since:

0.4.0

setBoolean

public void setBoolean(Column column,
                       boolean value)

Since:

0.4.0

setBoolean

public void setBoolean(int columnIndex,
                       boolean value)

Since:

0.4.0

setLong

public void setLong(Column column,
                    long value)

Since:

0.4.0

setLong

public void setLong(int columnIndex,
                    long value)

Since:

0.4.0

setDouble

public void setDouble(Column column,
                      double value)

Since:

0.4.0

setDouble

public void setDouble(int columnIndex,
                      double value)

Since:

0.4.0

setString

public void setString(Column column,
                      String value)

Since:

0.4.0

setString

public void setString(int columnIndex,
                      String value)

Since:

0.4.0

setJson

@Deprecated
public void setJson(Column column,
                                org.msgpack.value.Value value)

Deprecated. Use setJson(org.embulk.spi.Column, org.embulk.spi.json.JsonValue) instead.

Sets a JSON value at the specified column in the msgpack-java representation.

Parameters:

column - the column to set the JSON value

value - the JSON value in the msgpack-java representation

Since:

0.8.0

setJson

public void setJson(Column column,
                    JsonValue value)

Sets a JSON value at the specified column.

Parameters:

column - the column to set the JSON value

value - the JSON value

Since:

0.10.42

setJson

@Deprecated
public void setJson(int columnIndex,
                                org.msgpack.value.Value value)

Deprecated. Use setJson(int, org.embulk.spi.json.JsonValue) instead.

Sets a JSON value at the specified column in the msgpack-java representation.

Parameters:

columnIndex - the index of the column to set the JSON value

value - the JSON value in the msgpack-java representation

Since:

0.8.0

setJson

public void setJson(int columnIndex,
                    JsonValue value)

Sets a JSON value at the specified column.

Parameters:

columnIndex - the index of the column to set the JSON value

value - the JSON value

Since:

0.10.42

setTimestamp

@Deprecated
public void setTimestamp(Column column,
                                     Timestamp value)

Deprecated.

Since:

0.4.0

setTimestamp

public void setTimestamp(Column column,
                         Instant value)

Since:

0.10.13

setTimestamp

@Deprecated
public void setTimestamp(int columnIndex,
                                     Timestamp value)

Deprecated.

Since:

0.4.0

setTimestamp

public void setTimestamp(int columnIndex,
                         Instant value)

Since:

0.10.13

addRecord

public void addRecord()

Since:

0.4.0

flush

public void flush()

Since:

0.4.0

finish

public void finish()

Since:

0.4.0

close

public void close()

Specified by:

close in interface AutoCloseable

Since:

0.4.0