org.apache.beam.sdk.extensions.sorter

Class ExternalSorter

java.lang.Object

org.apache.beam.sdk.extensions.sorter.ExternalSorter

public abstract class ExternalSorter
extends java.lang.Object

Does an external sort of the provided values.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExternalSorter.Options ExternalSorter.Options contains configuration of the sorter.

Field Summary

Fields

Modifier and Type	Field and Description
protected ExternalSorter.Options	options

Method Summary

Modifier and Type	Method and Description
void	add(KV<byte[],byte[]> record) Adds a given record to the sorter.
static ExternalSorter	create(ExternalSorter.Options options) Returns a Sorter configured with the given ExternalSorter.Options.
java.lang.Iterable<KV<byte[],byte[]>>	sort() Sorts the added elements and returns an Iterable over the sorted elements.

Methods inherited from class java.lang.Object

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

Field Detail

options

protected final ExternalSorter.Options options

Method Detail

create

public static ExternalSorter create(ExternalSorter.Options options)

Returns a Sorter configured with the given ExternalSorter.Options.

add

public void add(KV<byte[],byte[]> record)
         throws java.io.IOException

Adds a given record to the sorter.

Records can only be added before calling sort().

Throws:

java.io.IOException

sort

public java.lang.Iterable<KV<byte[],byte[]>> sort()
                                           throws java.io.IOException

Sorts the added elements and returns an Iterable over the sorted elements.

Can be called at most once.

Throws:

java.io.IOException