## org.apache.hadoop.contrib.index.mapred
Class DocumentID

    java.lang.Object
      org.apache.hadoop.contrib.index.mapred.DocumentID

All Implemented Interfaces:
  Comparable, Writable, WritableComparable

    public class DocumentID

extends Object
implements WritableComparable

The class represents a document id, which is of type text.

Constructor Summary
`DocumentID()` Constructor.

Method Summary
`int` `compareTo(Object obj)`
`Text` `getText()` The text of the document id.
`int` `hashCode()`
`void` `readFields(DataInput in)` Deserialize the fields of this object from `in`.
`String` `toString()`
`void` `write(DataOutput out)` Serialize the fields of this object to `out`.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

### DocumentID

    public DocumentID()

  Constructor.

Method Detail

### getText

    public Text getText()

  The text of the document id.

  Returns:
    the text

### compareTo

    public int compareTo(Object obj)

  Specified by:
    `compareTo` in interface `Comparable`

### hashCode

    public int hashCode()

  Overrides:
    `hashCode` in class `Object`

### toString

    public String toString()

  Overrides:
    `toString` in class `Object`

### write

    public void write(DataOutput out)
               throws IOException

  Description copied from interface: `Writable`
  Serialize the fields of this object to `out`.

  Specified by:
    `write` in interface `Writable`
  Parameters:
    `out` - `DataOuput` to serialize this object into.
  Throws:
    `IOException`

### readFields

    public void readFields(DataInput in)
                    throws IOException

  Description copied from interface: `Writable`
  Deserialize the fields of this object from `in`.

  For efficiency, implementations should attempt to re-use storage in the existing object where possible.

  Specified by:
    `readFields` in interface `Writable`
  Parameters:
    `in` - `DataInput` to deseriablize this object from.
  Throws:
    `IOException`

Copyright © 2009 The Apache Software Foundation