com.asakusafw.runtime.io.util

Class ShuffleKey<TGroup extends WritableRawComparable,TOrder extends WritableRawComparable>

java.lang.Object

com.asakusafw.runtime.io.util.ShuffleKey<TGroup,TOrder>

Type Parameters:

TGroup - type for grouping

TOrder - type for ordering

All Implemented Interfaces:

WritableRawComparable, Comparable<WritableRawComparable>, org.apache.hadoop.io.Writable, org.apache.hadoop.io.WritableComparable<WritableRawComparable>

Direct Known Subclasses:

AbstractDirectOutputKey

public abstract class ShuffleKey<TGroup extends WritableRawComparable,TOrder extends WritableRawComparable>
extends Object
implements WritableRawComparable

An abstract implementation of shuffling keys.

Since:

0.2.5

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShuffleKey.AbstractGroupComparator An abstract implementation of grouping comparator for ShuffleKey.
static class	ShuffleKey.AbstractOrderComparator An abstract implementation of ordering comparator for ShuffleKey.
static class	ShuffleKey.Partitioner An implementation of partitioner for ShuffleKey.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ShuffleKey(Class<TGroup> groupType, Class<TOrder> orderType) Creates a new instance.
protected	ShuffleKey(TGroup groupObject, TOrder orderObject) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
int	compareInBytes(byte[] b1, int o1, byte[] b2, int o2) Compares two objects in bytes.
int	compareTo(WritableRawComparable o)
boolean	equals(Object obj)
TGroup	getGroupObject() Returns an object for grouping.
TOrder	getOrderObject() Returns an object for ordering.
int	getSizeInBytes(byte[] buf, int offset) Computes and returns size in bytes.
int	hashCode()
void	readFields(DataInput in)
String	toString()
void	write(DataOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ShuffleKey

protected ShuffleKey(Class<TGroup> groupType,
                     Class<TOrder> orderType)

Creates a new instance.

Parameters:

groupType - type for grouping

orderType - tyoe for ordering

Throws:

IllegalArgumentException - if some parameters were null

ShuffleKey

protected ShuffleKey(TGroup groupObject,
                     TOrder orderObject)

Creates a new instance.

Parameters:

groupObject - object for grouping

orderObject - object for ordering

Throws:

IllegalArgumentException - if some parameters were null

Method Detail

getGroupObject

public final TGroup getGroupObject()

Returns an object for grouping.

Returns:

the group object

getOrderObject

public final TOrder getOrderObject()

Returns an object for ordering.

Returns:

the order object

compareTo

public final int compareTo(WritableRawComparable o)

Specified by:

compareTo in interface Comparable<WritableRawComparable>

write

public final void write(DataOutput out)
                 throws IOException

Specified by:

write in interface org.apache.hadoop.io.Writable

Throws:

IOException

readFields

public final void readFields(DataInput in)
                      throws IOException

Specified by:

readFields in interface org.apache.hadoop.io.Writable

Throws:

IOException

getSizeInBytes

public final int getSizeInBytes(byte[] buf,
                                int offset)
                         throws IOException

Description copied from interface: WritableRawComparable

Computes and returns size in bytes.

Specified by:

getSizeInBytes in interface WritableRawComparable

Parameters:

buf - bytes array

offset - bytes offset

Returns:

size in bytes

Throws:

IOException - if failed to compute size

compareInBytes

public final int compareInBytes(byte[] b1,
                                int o1,
                                byte[] b2,
                                int o2)
                         throws IOException

Description copied from interface: WritableRawComparable

Compares two objects in bytes.

Specified by:

compareInBytes in interface WritableRawComparable

Parameters:

b1 - bytes representation of the first object

o1 - offset of the first object

b2 - bytes representation of the second object

o2 - offset of the second object

Returns:

the comparison result

Throws:

IOException - if failed to comparison

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

toString

public final String toString()

Overrides:

toString in class Object