dragon.ir.index
Class IRTerm

java.lang.Object
  |
  +--dragon.ir.index.IRTerm
All Implemented Interfaces:
java.lang.Comparable, FrequencySortable, IndexSortable, IRSignature, java.io.Serializable

public class IRTerm
extends java.lang.Object
implements IRSignature, IndexSortable, FrequencySortable, java.lang.Comparable, java.io.Serializable

This is basic indexing unit which can be sorted and compared by index and frequency

Copyright: Copyright (c) 2005

Company: IST, Drexel University

Version:
1.0
Author:
Davis Zhou
See Also:
Serialized Form

Constructor Summary
IRTerm(int index, int frequency)
           
IRTerm(int index, int frequency, int docFrequency)
           
IRTerm(java.lang.String key)
           
IRTerm(java.lang.String key, int index, int frequency)
           
 
Method Summary
 void addDocFrequency(int inc)
           
 void addFrequency(int inc)
           
 int compareTo(java.lang.Object obj)
           
 IRTerm copy()
           
 int getDocFrequency()
           
 int getFrequency()
           
 int getIndex()
           
 java.lang.String getKey()
           
 void setDocFrequency(int freq)
           
 void setFrequency(int freq)
           
 void setIndex(int index)
           
 void setKey(java.lang.String key)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IRTerm

public IRTerm(java.lang.String key)

IRTerm

public IRTerm(int index,
              int frequency)

IRTerm

public IRTerm(java.lang.String key,
              int index,
              int frequency)

IRTerm

public IRTerm(int index,
              int frequency,
              int docFrequency)
Method Detail

copy

public IRTerm copy()

getKey

public java.lang.String getKey()

setKey

public void setKey(java.lang.String key)

setFrequency

public void setFrequency(int freq)
Specified by:
setFrequency in interface IRSignature

addFrequency

public void addFrequency(int inc)

getFrequency

public int getFrequency()
Specified by:
getFrequency in interface IRSignature

getIndex

public int getIndex()
Specified by:
getIndex in interface IRSignature

setIndex

public void setIndex(int index)
Specified by:
setIndex in interface IRSignature

getDocFrequency

public int getDocFrequency()
Specified by:
getDocFrequency in interface IRSignature

addDocFrequency

public void addDocFrequency(int inc)

setDocFrequency

public void setDocFrequency(int freq)
Specified by:
setDocFrequency in interface IRSignature

compareTo

public int compareTo(java.lang.Object obj)
Specified by:
compareTo in interface java.lang.Comparable