Package oracle.pgx.api.frames

Class PgxFrameReader<PgxFrameReaderType extends PgxFrameReader<PgxFrameReaderType>>

java.lang.Object

oracle.pgx.api.frames.PgxFrameReader<PgxFrameReaderType>

Direct Known Subclasses:

PgxCsvFrameReader, PgxDbFrameReader, PgxGenericFrameReader, PgxPgbFrameReader

public abstract class PgxFrameReader<PgxFrameReaderType extends PgxFrameReader<PgxFrameReaderType>>
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
PgxFrameReaderType	autodetectColumns(boolean autodetectColumn)	enables or disables the autodetection of columns from the table Not all formats support autodetection of the columns (only DB in fact)
PgxFrameReaderType	columns(ColumnDescriptor... columnDescriptors)	sets the columns to be loaded from their columnDescriptors
PgxFrame	load(java.lang.String... uris)	triggers the loading of the PgxFrame
abstract PgxFuture<PgxFrame>	loadAsync(java.lang.String... uris)	trigger the async loading of the PgxFrame
abstract PgxFrameReaderType	name(java.lang.String frameName)

Methods inherited from class java.lang.Object

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

Method Detail

name

public abstract PgxFrameReaderType name(java.lang.String frameName)

autodetectColumns

public PgxFrameReaderType autodetectColumns(boolean autodetectColumn)

enables or disables the autodetection of columns from the table Not all formats support autodetection of the columns (only DB in fact)

Parameters:

autodetectColumn - boolean denoting if the columns should be autodetected

Returns:

this loader

columns

public PgxFrameReaderType columns(ColumnDescriptor... columnDescriptors)

sets the columns to be loaded from their columnDescriptors

Parameters:

columnDescriptors - ColumnDescriptors array containing the to be loaded columns

Returns:

this loader

loadAsync

public abstract PgxFuture<PgxFrame> loadAsync(java.lang.String... uris)

trigger the async loading of the PgxFrame

Parameters:

uris - array denoting the uris

Returns:

the future for the result of the operation

load

public PgxFrame load(java.lang.String... uris)
              throws java.lang.InterruptedException,
                     java.util.concurrent.ExecutionException

triggers the loading of the PgxFrame

Parameters:

uris - array denoting the uris

Returns:

the loaded frame

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException