IRDoc (Dragontool 1.3.3 API)

java.lang.Object
- dragon.ir.index.IRDoc

All Implemented Interfaces:

IndexSortable, WeightSortable, Serializable, Comparable
```
public class IRDoc
extends Object
implements WeightSortable, IndexSortable, Comparable, Serializable
```
IRDoc is data structure for IR document indexing which can be sorted and thus compared by weight and index

Description:

Copyright: Copyright (c) 2005

Company: IST, Drexel University

Version:

1.0

Author:

Davis Zhou

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

IRDoc(int index)

IRDoc(String key)

Constructors
Constructor and Description
`IRDoc(int index)`
`IRDoc(String key)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(IRDoc doc)`
`int`	`compareTo(Object obj)`
`IRDoc`	`copy()`
`int`	`getCategory()`
`int`	`getIndex()`
`String`	`getKey()`
`int`	`getRelationCount()`
`int`	`getRelationNum()`
`int`	`getTermCount()`
`int`	`getTermNum()`
`double`	`getWeight()`
`void`	`setCategory(int category)`
`void`	`setIndex(int index)`
`void`	`setKey(String key)`
`void`	`setRelationCount(int relationCount)`
`void`	`setRelationNum(int relationNum)`
`void`	`setTermCount(int termCount)`
`void`	`setTermNum(int termNum)`
`void`	`setWeight(double weight)`

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

Constructor Detail

IRDoc
```
public IRDoc(String key)
```

IRDoc
```
public IRDoc(int index)
```

Method Detail

copy
```
public IRDoc copy()
```

getKey
```
public String getKey()
```

setKey
```
public void setKey(String key)
```

getCategory
```
public int getCategory()
```

setCategory

public void setCategory(int category)

getTermNum
```
public int getTermNum()
```

setTermNum
```
public void setTermNum(int termNum)
```

getTermCount
```
public int getTermCount()
```

setTermCount

public void setTermCount(int termCount)

getRelationNum
```
public int getRelationNum()
```

setRelationNum

public void setRelationNum(int relationNum)

getRelationCount
```
public int getRelationCount()
```

setRelationCount

public void setRelationCount(int relationCount)

getIndex
```
public int getIndex()
```
Specified by:

getIndex in interface IndexSortable

setIndex
```
public void setIndex(int index)
```
Specified by:

setIndex in interface IndexSortable

setWeight
```
public void setWeight(double weight)
```
Specified by:

setWeight in interface WeightSortable

getWeight
```
public double getWeight()
```
Specified by:

getWeight in interface WeightSortable

compareTo
```
public int compareTo(Object obj)
```
Specified by:

compareTo in interface Comparable

compareTo
```
public int compareTo(IRDoc doc)
```

Class IRDoc

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IRDoc

IRDoc

Method Detail

copy

getKey

setKey

getCategory

setCategory

getTermNum

setTermNum

getTermCount

setTermCount

getRelationNum

setRelationNum

getRelationCount

setRelationCount

getIndex

setIndex

setWeight

getWeight

compareTo

compareTo