|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.terrier.structures.DocumentIndexEntry org.terrier.structures.BasicDocumentIndexEntry
public class BasicDocumentIndexEntry
A basic document index entry. Allows the creation of a document index entries.
Nested Class Summary | |
---|---|
static class |
BasicDocumentIndexEntry.Factory
Returna a factory for creating document index entries |
Field Summary |
---|
Fields inherited from interface org.terrier.structures.BitIndexPointer |
---|
BIT_MASK, FILE_SHIFT, MAX_FILE_ID |
Constructor Summary | |
---|---|
BasicDocumentIndexEntry()
Constructs an instance of the BasicDocumentIndexEntry. |
|
BasicDocumentIndexEntry(DocumentIndexEntry in)
Constructs an instance of the BasicDocumentIndexEntry. |
|
BasicDocumentIndexEntry(int length,
BitIndexPointer pointer)
Constructs an instance of the BasicDocumentIndexEntry. |
|
BasicDocumentIndexEntry(int length,
byte fileId,
long byteOffset,
byte bitOffset,
int numberOfTerms)
Constructs an instance of the BasicDocumentIndexEntry. |
Method Summary | |
---|---|
java.lang.String |
pointerToString()
Returns a textual representation of the pointer alone |
void |
readFields(java.io.DataInput in)
|
void |
setBitIndexPointer(BitIndexPointer pointer)
Update this pointer to reflect the same values as the specified pointer |
void |
setNumberOfEntries(int n)
Set the number of "things that the pointer refers to |
void |
setOffset(BitFilePosition pos)
Set the offset |
void |
setPointer(Pointer p)
Sets the pointer within this object to that represented by the specified pointer |
void |
write(java.io.DataOutput out)
|
Methods inherited from class org.terrier.structures.DocumentIndexEntry |
---|
getDocumentLength, getFileNumber, getNumberOfEntries, getOffset, getOffsetBits, setDocumentLength, setFileNumber, setOffset, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public BasicDocumentIndexEntry()
public BasicDocumentIndexEntry(DocumentIndexEntry in)
in
- public BasicDocumentIndexEntry(int length, BitIndexPointer pointer)
length
- pointer
- public BasicDocumentIndexEntry(int length, byte fileId, long byteOffset, byte bitOffset, int numberOfTerms)
length
- fileId
- byteOffset
- bitOffset
- numberOfTerms
- Method Detail |
---|
public void readFields(java.io.DataInput in) throws java.io.IOException
java.io.IOException
public void write(java.io.DataOutput out) throws java.io.IOException
java.io.IOException
public void setBitIndexPointer(BitIndexPointer pointer)
pointer
- - pointer to use to set the offset, bit offset
and file Id parameters.public void setOffset(BitFilePosition pos)
public void setNumberOfEntries(int n)
public java.lang.String pointerToString()
public void setPointer(Pointer p)
p
- other pointer to update the pointer in this object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |