org.embulk.spi

Class PageReader

java.lang.Object

org.embulk.spi.PageReader

All Implemented Interfaces:

AutoCloseable

public class PageReader
extends Object
implements AutoCloseable

Reads data records from Pages set with setPage(Page).

Since:

0.4.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	getBoolean(Column column)
boolean	getBoolean(int columnIndex)
double	getDouble(Column column)
double	getDouble(int columnIndex)
Value	getJson(Column column) Deprecated. Use getJsonValue(org.embulk.spi.Column) instead.
Value	getJson(int columnIndex) Deprecated. Use getJsonValue(int) instead.
JsonValue	getJsonValue(Column column) Returns a JSON value at the specified column.
JsonValue	getJsonValue(int columnIndex) Returns a JSON value at the specified column.
long	getLong(Column column)
long	getLong(int columnIndex)
static int	getRecordCount(Page page)
Schema	getSchema()
String	getString(Column column)
String	getString(int columnIndex)
Timestamp	getTimestamp(Column column) Deprecated. Use getTimestampInstant(Column) instead.
Timestamp	getTimestamp(int columnIndex) Deprecated. Use getTimestampInstant(int) instead.
Instant	getTimestampInstant(Column column)
Instant	getTimestampInstant(int columnIndex)
boolean	isNull(Column column)
boolean	isNull(int columnIndex)
boolean	nextRecord()
void	setPage(Page page)

Methods inherited from class java.lang.Object

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

Constructor Detail

PageReader

public PageReader(Schema schema)

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

Constructs a PageReader instance.

Since:

0.4.0

Method Detail

getRecordCount

public static int getRecordCount(Page page)

Since:

0.4.0

setPage

public void setPage(Page page)

Since:

0.4.0

getSchema

public Schema getSchema()

Since:

0.4.0

isNull

public boolean isNull(Column column)

Since:

0.4.0

isNull

public boolean isNull(int columnIndex)

Since:

0.4.0

getBoolean

public boolean getBoolean(Column column)

Since:

0.4.0

getBoolean

public boolean getBoolean(int columnIndex)

Since:

0.4.0

getLong

public long getLong(Column column)

Since:

0.4.0

getLong

public long getLong(int columnIndex)

Since:

0.4.0

getDouble

public double getDouble(Column column)

Since:

0.4.0

getDouble

public double getDouble(int columnIndex)

Since:

0.4.0

getString

public String getString(Column column)

Since:

0.4.0

getString

public String getString(int columnIndex)

Since:

0.4.0

getTimestamp

@Deprecated
public Timestamp getTimestamp(Column column)

Deprecated. Use getTimestampInstant(Column) instead.

Returns a Timestamp value.

Since:

0.4.0

getTimestamp

@Deprecated
public Timestamp getTimestamp(int columnIndex)

Deprecated. Use getTimestampInstant(int) instead.

Returns a Timestamp value.

Since:

0.4.0

getTimestampInstant

public Instant getTimestampInstant(Column column)

Since:

0.10.13

getTimestampInstant

public Instant getTimestampInstant(int columnIndex)

Since:

0.10.13

getJson

@Deprecated
public Value getJson(Column column)

Deprecated. Use getJsonValue(org.embulk.spi.Column) instead.

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

Parameters:

column - the column to get the JSON value

Returns:

the JSON value in the msgpack-java representation

Since:

0.8.0

getJson

@Deprecated
public Value getJson(int columnIndex)

Deprecated. Use getJsonValue(int) instead.

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

Parameters:

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

Returns:

the JSON value in the msgpack-java representation

Since:

0.8.0

getJsonValue

public JsonValue getJsonValue(Column column)

Returns a JSON value at the specified column.

Parameters:

column - the column to get the JSON value

Returns:

the JSON value

Since:

0.10.42

getJsonValue

public JsonValue getJsonValue(int columnIndex)

Returns a JSON value at the specified column.

Parameters:

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

Returns:

the JSON value

Since:

0.10.42

nextRecord

public boolean nextRecord()

Since:

0.4.0

close

public void close()

Specified by:

close in interface AutoCloseable

Since:

0.4.0