edu.umd.cloud9.io.array
Class ArrayListWritableComparable<E extends WritableComparable>

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractList<E>
          java.util.ArrayList<E>
              edu.umd.cloud9.io.array.ArrayListWritableComparable<E>

Type Parameters:

E - type of list element

All Implemented Interfaces:

Serializable, Cloneable, Comparable, Iterable<E>, Collection<E>, List<E>, RandomAccess, Writable, WritableComparable

public class ArrayListWritableComparable<E extends WritableComparable>
extends ArrayList<E>
implements WritableComparable

WritableComparable extension of a Java ArrayList. Elements in the list must be homogeneous and must implement Hadoop's WritableComparable interface. This class, combined with Tuple, allows the user to define arbitrarily complex data structures.

Author:

Jimmy Lin, Tamer Elsayed

See Also:

Tuple, Serialized Form

Constructor Summary

ArrayListWritableComparable()
Creates an ArrayListWritableComparable object.

ArrayListWritableComparable(ArrayList<E> array)
Creates an ArrayListWritableComparable object from a regular ArrayList.

Method Summary

int	compareTo(Object obj) Defines a natural sort order for the ListWritable class.
void	readFields(DataInput in) Deserializes the array.
String	toString() Generates human-readable String representation of this ArrayList.
void	write(DataOutput out) Serializes this Tuple.

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, remove, remove, set, size, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode, iterator, listIterator, listIterator, subList

Methods inherited from class java.util.AbstractCollection

containsAll, removeAll, retainAll

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode, iterator, listIterator, listIterator, removeAll, retainAll, subList

Constructor Detail

ArrayListWritableComparable

public ArrayListWritableComparable()

Creates an ArrayListWritableComparable object.

ArrayListWritableComparable

public ArrayListWritableComparable(ArrayList<E> array)

Creates an ArrayListWritableComparable object from a regular ArrayList.

Method Detail

readFields

public void readFields(DataInput in)
                throws IOException

Deserializes the array.

Specified by:

readFields in interface Writable

Parameters:

in - source for raw byte representation

Throws:

IOException

write

public void write(DataOutput out)
           throws IOException

Serializes this Tuple.

Specified by:

write in interface Writable

Parameters:

out - where to write the raw byte representation

Throws:

IOException

compareTo

public int compareTo(Object obj)

Defines a natural sort order for the ListWritable class. Following standard convention, this method returns a value less than zero, a value greater than zero, or zero if this ListWritable should be sorted before, sorted after, or is equal to obj. The sort order is defined as follows:

• Each element in the list is compared sequentially from first to last.
• Lists are sorted with respect to the natural order of the current list element under consideration, by calling its compareTo method.
• If the current list elements are equal, the next set of elements are considered.
• If all compared elements are equal, but lists are different lengths, the shorter list is sorted first.
• If all list elements are equal and the lists are equal in length, then the lists are considered equal

Specified by:

compareTo in interface Comparable

Returns:

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

toString

public String toString()

Generates human-readable String representation of this ArrayList.

Overrides:

toString in class AbstractCollection<E extends WritableComparable>

Returns:

human-readable String representation of this ArrayList