org.apache.crunch.io

Interface ReadableSource<T>

All Superinterfaces:

Source<T>

All Known Subinterfaces:

ReadableSourceTarget<T>

All Known Implementing Classes:

DataBaseSource, org.apache.crunch.io.impl.FileSourceImpl

public interface ReadableSource<T>
extends Source<T>

An extension of the Source interface that indicates that a Source instance may be read as a series of records by the client code. This is used to determine whether a PCollection instance can be materialized.

Method Summary

Modifier and Type	Method and Description
ReadableData<T>	asReadable()
Iterable<T>	read(org.apache.hadoop.conf.Configuration conf) Returns an Iterable that contains the contents of this source.

Methods inherited from interface org.apache.crunch.Source

configureSource, getConverter, getLastModifiedAt, getSize, getType, inputConf

Method Detail

read

Iterable<T> read(org.apache.hadoop.conf.Configuration conf)
          throws IOException

Returns an Iterable that contains the contents of this source.

Parameters:

conf - The current Configuration instance

Returns:

the contents of this Source as an Iterable instance

Throws:

IOException

asReadable

ReadableData<T> asReadable()

Returns:

a ReadableData instance containing the data referenced by this ReadableSource.