org.terrier.structures
Class FieldDocumentIndexEntry

java.lang.Object
  org.terrier.structures.DocumentIndexEntry
      org.terrier.structures.BasicDocumentIndexEntry
          org.terrier.structures.FieldDocumentIndexEntry

All Implemented Interfaces:

org.apache.hadoop.io.Writable, BitFilePosition, BitIndexPointer, Pointer

public class FieldDocumentIndexEntry
extends BasicDocumentIndexEntry

A document index entry for use with fields

Nested Class Summary

static class

FieldDocumentIndexEntry.Factory Factory for creating a field document index entry

Field Summary

protected int[]

fieldLengths

Fields inherited from interface org.terrier.structures.BitIndexPointer

BIT_MASK, FILE_SHIFT, MAX_FILE_ID

Constructor Summary

FieldDocumentIndexEntry()
Constructs an instance of the class.

FieldDocumentIndexEntry(DocumentIndexEntry die)
Constructs an instance of the class with

FieldDocumentIndexEntry(int fieldCount)
Constructs an instance of the class with

Method Summary

int[]	getFieldLengths() Get the lengths of each field
void	readFields(java.io.DataInput in)
void	setFieldLengths(int[] f_lens) Set the lengths of each field
java.lang.String	toString()
void	write(java.io.DataOutput out)

Methods inherited from class org.terrier.structures.BasicDocumentIndexEntry

pointerToString, setBitIndexPointer, setNumberOfEntries, setOffset, setPointer

Methods inherited from class org.terrier.structures.DocumentIndexEntry

getDocumentLength, getFileNumber, getNumberOfEntries, getOffset, getOffsetBits, setDocumentLength, setFileNumber, setOffset

Methods inherited from class java.lang.Object

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

Field Detail

fieldLengths

protected int[] fieldLengths

Constructor Detail

FieldDocumentIndexEntry

public FieldDocumentIndexEntry()

Constructs an instance of the class.

FieldDocumentIndexEntry

public FieldDocumentIndexEntry(DocumentIndexEntry die)

Constructs an instance of the class with

Parameters:

die -

FieldDocumentIndexEntry

public FieldDocumentIndexEntry(int fieldCount)

Constructs an instance of the class with

Parameters:

fieldCount -

Method Detail

getFieldLengths

public int[] getFieldLengths()

Get the lengths of each field

setFieldLengths

public void setFieldLengths(int[] f_lens)

Set the lengths of each field

readFields

public void readFields(java.io.DataInput in)
                throws java.io.IOException

Description copied from class: BasicDocumentIndexEntry

Specified by:

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

Overrides:

readFields in class BasicDocumentIndexEntry

Throws:

java.io.IOException

write

public void write(java.io.DataOutput out)
           throws java.io.IOException

Description copied from class: BasicDocumentIndexEntry

Specified by:

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

Overrides:

write in class BasicDocumentIndexEntry

Throws:

java.io.IOException

toString

public java.lang.String toString()

Description copied from class: DocumentIndexEntry

Overrides:

toString in class DocumentIndexEntry