dragon.ir.index

Class IRTerm

java.lang.Object

dragon.ir.index.IRTerm

All Implemented Interfaces:

IRSignature, FrequencySortable, IndexSortable, Serializable, Comparable

public class IRTerm
extends Object
implements IRSignature, IndexSortable, FrequencySortable, Comparable, 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

Constructors

Constructor and Description
IRTerm(int index, int frequency)
IRTerm(int index, int frequency, int docFrequency)
IRTerm(String key)
IRTerm(String key, int index, int frequency)

Method Summary

Modifier and Type	Method and Description
void	addDocFrequency(int inc)
void	addFrequency(int inc)
int	compareTo(Object obj)
IRTerm	copy()
int	getDocFrequency()
int	getFrequency()
int	getIndex()
String	getKey()
void	setDocFrequency(int freq)
void	setFrequency(int freq)
void	setIndex(int index)
void	setKey(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(String key)

IRTerm

public IRTerm(int index,
              int frequency)

IRTerm

public IRTerm(String key,
              int index,
              int frequency)

IRTerm

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

Method Detail

copy

public IRTerm copy()

getKey

public String getKey()

setKey

public void setKey(String key)

setFrequency

public void setFrequency(int freq)

Specified by:

setFrequency in interface IRSignature

Specified by:

setFrequency in interface FrequencySortable

addFrequency

public void addFrequency(int inc)

getFrequency

public int getFrequency()

Specified by:

getFrequency in interface IRSignature

Specified by:

getFrequency in interface FrequencySortable

getIndex

public int getIndex()

Specified by:

getIndex in interface IRSignature

Specified by:

getIndex in interface IndexSortable

setIndex

public void setIndex(int index)

Specified by:

setIndex in interface IRSignature

Specified by:

setIndex in interface IndexSortable

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(Object obj)

Specified by:

compareTo in interface Comparable