tl.lin.data.pair

Class PairOfStringInt

java.lang.Object

tl.lin.data.pair.PairOfStringInt

All Implemented Interfaces:

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

public class PairOfStringInt
extends Object
implements org.apache.hadoop.io.WritableComparable<PairOfStringInt>

WritableComparable representing a pair consisting of a String and an int. The elements in the pair are referred to as the left and right elements. The natural sort order is: first by the left element, and then by the right element.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PairOfStringInt.Comparator Comparator optimized for PairOfStringInt.

Constructor Summary

Constructors

Constructor and Description
PairOfStringInt() Creates a pair.
PairOfStringInt(String left, int right) Creates a pair.

Method Summary

Methods

Modifier and Type	Method and Description
PairOfStringInt	clone() Clones this object.
int	compareTo(PairOfStringInt pair) Defines a natural sort order for pairs.
boolean	equals(Object obj) Checks two pairs for equality.
String	getKey() Returns the key (left element).
String	getLeftElement() Returns the left element.
int	getRightElement() Returns the right element.
int	getValue() Returns the value (right element).
int	hashCode() Returns a hash code value for the pair.
void	readFields(DataInput in) Deserializes the pair.
void	set(String left, int right) Sets the right and left elements of this pair.
String	toString() Generates human-readable String representation of this pair.
void	write(DataOutput out) Serializes this pair.

Methods inherited from class java.lang.Object

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

Constructor Detail

PairOfStringInt

public PairOfStringInt()

Creates a pair.

PairOfStringInt

public PairOfStringInt(String left,
               int right)

Creates a pair.

Parameters:

left - the left element

right - the right element

Method Detail

readFields

public void readFields(DataInput in)
                throws IOException

Deserializes the pair.

Specified by:

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

Parameters:

in - source for raw byte representation

Throws:

IOException

write

public void write(DataOutput out)
           throws IOException

Serializes this pair.

Specified by:

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

Parameters:

out - where to write the raw byte representation

Throws:

IOException

getLeftElement

public String getLeftElement()

Returns the left element.

Returns:

the left element

getRightElement

public int getRightElement()

Returns the right element.

Returns:

the right element

getKey

public String getKey()

Returns the key (left element).

Returns:

the key

getValue

public int getValue()

Returns the value (right element).

Returns:

the value

set

public void set(String left,
       int right)

Sets the right and left elements of this pair.

Parameters:

left - the left element

right - the right element

equals

public boolean equals(Object obj)

Checks two pairs for equality.

Overrides:

equals in class Object

Parameters:

obj - object for comparison

Returns:

true if obj is equal to this object, false otherwise

compareTo

public int compareTo(PairOfStringInt pair)

Defines a natural sort order for pairs. Pairs are sorted first by the left element, and then by the right element.

Specified by:

compareTo in interface Comparable<PairOfStringInt>

Returns:

a value less than zero, a value greater than zero, or zero if this pair should be sorted before, sorted after, or is equal to obj.

hashCode

public int hashCode()

Returns a hash code value for the pair.

Overrides:

hashCode in class Object

Returns:

hash code for the pair

toString

public String toString()

Generates human-readable String representation of this pair.

Overrides:

toString in class Object

Returns:

human-readable String representation of this pair

clone

public PairOfStringInt clone()

Clones this object.

Overrides:

clone in class Object

Returns:

clone of this object