IndexReader (Dragontool 1.3.3 API)

All Known Subinterfaces:

SequenceIndexReader

All Known Implementing Classes:

AbstractIndexReader, AbstractSequenceIndexReader, BasicIndexReader, BasicSentenceIndexReader, BasicSequenceIndexReader, OnlineIndexReader, OnlineSentenceIndexReader, OnlineSequenceIndexReader
```
public interface IndexReader
```
Interface of index reader

Copyright: Copyright (c) 2005

Company: IST, Drexel University

Version:

1.0

Author:

Davis Zhou

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` This method releases all occupied resources.
`IRCollection`	`getCollection()`
`IRDoc`	`getDoc(int index)`
`IRDoc`	`getDoc(String key)`
`String`	`getDocKey(int index)`
`IRRelation`	`getIRRelation(int index)`
`IRRelation`	`getIRRelation(int relationIndex, int docIndex)` If the given document does not contain the given relation, this method returns null.
`IRTerm`	`getIRTerm(int index)`
`IRTerm`	`getIRTerm(int termIndex, int docIndex)` If the given document does not contain the given term, this method returns null.
`IRTerm`	`getIRTerm(String key)`
`Article`	`getOriginalDoc(int index)`
`Article`	`getOriginalDoc(String key)`
`int[]`	`getRelationDocFrequencyList(int relationIndex)`
`int[]`	`getRelationDocIndexList(int relationIndex)`
`IRDoc[]`	`getRelationDocList(int relationIndex)`
`int[]`	`getRelationFrequencyList(int docIndex)` To know what relation the frequency corresponds to, call the method getRelationIndexList.
`int[]`	`getRelationIndexList(int docIndex)`
`IRRelation[]`	`getRelationList(int docIndex)`
`int[]`	`getTermDocFrequencyList(int termIndex)`
`int[]`	`getTermDocIndexList(int termIndex)`
`IRDoc[]`	`getTermDocList(int termIndex)`
`int[]`	`getTermFrequencyList(int docIndex)` To know what term the frequency corresponds to, call the method getTermIndexList.
`int[]`	`getTermIndexList(int docIndex)`
`String`	`getTermKey(int index)`
`IRTerm[]`	`getTermList(int docIndex)`
`void`	`initialize()` It is required to call this method before reading out any indexing information.
`boolean`	`isRelationSupported()`

- Method Detail
  - initialize
```
void initialize()
```
    It is required to call this method before reading out any indexing information.
  - close
```
void close()
```
    This method releases all occupied resources.
  - isRelationSupported
```
boolean isRelationSupported()
```
    Returns:
    
    true if the indexing contains relationship information
  - getCollection
```
IRCollection getCollection()
```
    Returns:
    
    IRCollection object which contains the statistics of the indexed collection
  - getDoc
```
IRDoc getDoc(int index)
```
    Parameters:
    
    index - the index of the document
    
    Returns:
    
    the IRDoc object
  - getDoc
```
IRDoc getDoc(String key)
```
    Parameters:
    
    key - the unique etnry number of the document
    
    Returns:
    
    the IRDoc object
  - getDocKey
```
String getDocKey(int index)
```
    Parameters:
    
    index - the index of the document
    
    Returns:
    
    the unique entry number of the index-th document
  - getOriginalDoc
```
Article getOriginalDoc(String key)
```
    Parameters:
    
    key - the unique entry number of the document
    
    Returns:
    
    the raw content of the indexed document
  - getOriginalDoc
```
Article getOriginalDoc(int index)
```
    Parameters:
    
    index - the index of the document
    
    Returns:
    
    the raw content of the indexed document
  - getTermList
```
IRTerm[] getTermList(int docIndex)
```
    Parameters:
    
    docIndex - the index of the document
    
    Returns:
    
    a list of unique terms in the given document
  - getTermIndexList
```
int[] getTermIndexList(int docIndex)
```
    Parameters:
    
    docIndex - the index of the document
    
    Returns:
    
    an interger array each elment of which is the index of unique terms in the given document
  - getTermFrequencyList
```
int[] getTermFrequencyList(int docIndex)
```
    To know what term the frequency corresponds to, call the method getTermIndexList.
    
    Parameters:
    
    docIndex - the index of the document
    
    Returns:
    
    an interger array each elment of which is the frequency of unique terms in the given document
  - getIRTerm
```
IRTerm getIRTerm(String key)
```
    Parameters:
    
    key - the name of the term
    
    Returns:
    
    the IRTerm object
  - getIRTerm
```
IRTerm getIRTerm(int index)
```
    Parameters:
    
    index - the index of the term
    
    Returns:
    
    the IRTerm object
  - getIRTerm
```
IRTerm getIRTerm(int termIndex,
                 int docIndex)
```
    If the given document does not contain the given term, this method returns null.
    
    Parameters:
    
    termIndex - the index of the term
    
    docIndex - the index of the document
    
    Returns:
    
    the IRTerm object
  - getTermKey
```
String getTermKey(int index)
```
    Parameters:
    
    index: - the index of the wanted term
    
    Returns:
    
    the name of the given term
  - getTermDocList
```
IRDoc[] getTermDocList(int termIndex)
```
    Parameters:
    
    termIndex - the index of the term
    
    Returns:
    
    a list of IRDoc objects which contain the specified term
  - getTermDocFrequencyList
```
int[] getTermDocFrequencyList(int termIndex)
```
    Parameters:
    
    termIndex - the index of the term
    
    Returns:
    
    a list of frequencies the given term occurs in the documents containing this term
  - getTermDocIndexList
```
int[] getTermDocIndexList(int termIndex)
```
    Parameters:
    
    termIndex - the index of the term
    
    Returns:
    
    a list of indices of documents containing this term
  - getRelationList
```
IRRelation[] getRelationList(int docIndex)
```
    Parameters:
    
    docIndex - the index of the document
    
    Returns:
    
    a list of unique relations in the given document
  - getRelationFrequencyList
```
int[] getRelationFrequencyList(int docIndex)
```
    To know what relation the frequency corresponds to, call the method getRelationIndexList.
    
    Parameters:
    
    docIndex - the index of the document
    
    Returns:
    
    an interger array each elment of which is the frequency of unique relations in the given document
  - getRelationIndexList
```
int[] getRelationIndexList(int docIndex)
```
    Parameters:
    
    docIndex - the index of the document
    
    Returns:
    
    an interger array each elment of which is the index of unique relations in the given document
  - getIRRelation
```
IRRelation getIRRelation(int index)
```
    Parameters:
    
    index - the index of the relation
    
    Returns:
    
    the IRRelation object
  - getIRRelation
```
IRRelation getIRRelation(int relationIndex,
                         int docIndex)
```
    If the given document does not contain the given relation, this method returns null.
    
    Parameters:
    
    relationIndex - the index of the relation
    
    docIndex - the index of the document
    
    Returns:
    
    the IRRelation object
  - getRelationDocList
```
IRDoc[] getRelationDocList(int relationIndex)
```
    Parameters:
    
    relationIndex - the index of the relation
    
    Returns:
    
    a list of IRDoc objects which contain the specified relation
  - getRelationDocFrequencyList
```
int[] getRelationDocFrequencyList(int relationIndex)
```
    Parameters:
    
    relationIndex - the index of the relation
    
    Returns:
    
    a list of frequencies the given relation occurs in the documents containing this relation
  - getRelationDocIndexList
```
int[] getRelationDocIndexList(int relationIndex)
```
    Parameters:
    
    relationIndex - the index of the relation
    
    Returns:
    
    a list of indices of documents containing this relation

Interface IndexReader

Method Summary

Method Detail

initialize

close

isRelationSupported

getCollection

getDoc

getDoc

getDocKey

getOriginalDoc

getOriginalDoc

getTermList

getTermIndexList

getTermFrequencyList

getIRTerm

getIRTerm

getIRTerm

getTermKey

getTermDocList

getTermDocFrequencyList

getTermDocIndexList

getRelationList

getRelationFrequencyList

getRelationIndexList

getIRRelation

getIRRelation

getRelationDocList

getRelationDocFrequencyList

getRelationDocIndexList