|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ScoredTermsCollection
Interface for a collection of scored terms.
Method Summary | |
---|---|
java.lang.Iterable<MIFSDocument> |
documents()
Gets an iterable over all the documents in this collection. |
MIFSDocument |
getDocument(int index)
Gets the document at the specified index. |
int |
getDocumentCount()
Gets the number of documents in the collection. |
IntIterator |
getDocumentsFor(int termIndex)
Gets an iterator of document indices of docs that contain a Term with the specified index. |
int |
getFrequency(int docIndex,
int termIndex)
Gets the frequency of the specified term in the specified document. |
DateRange |
getRange()
Gets the date range (inclusive) covered by this ScoredTermsCollection. |
float |
getScore(int docIndex,
int termIndex)
Gets the score of the specified term in the specified document. |
MIFSTerm |
getTerm(int index)
Gets the term at the specified index. |
int |
getTermCount()
Gets the number of terms in the collection. |
int |
getTermIndex(java.lang.String term)
Gets the index for the specified term. |
void |
iterateByDocument(ScoredDocumentCallback callback)
Iterates through the collection in document order calling the relevant methods in the callback. |
void |
iterateByTerm(ScoredTermCallback callback)
Iterates through the collection in term order calling the relevant methods in the callback. |
java.lang.Iterable<MIFSTerm> |
terms()
Gets an iterable over all the terms in this collection. |
Methods inherited from interface java.lang.Iterable |
---|
iterator |
Method Detail |
---|
java.lang.Iterable<MIFSTerm> terms()
java.lang.Iterable<MIFSDocument> documents()
void iterateByDocument(ScoredDocumentCallback callback)
callback
- methods are called on this obj during iterationvoid iterateByTerm(ScoredTermCallback callback) throws AIDAException
callback
- methods are called on this obj during iteration
AIDAException
- if there is during the callback.int getTermCount()
int getDocumentCount()
MIFSDocument getDocument(int index)
index
- the index of the document
MIFSTerm getTerm(int index)
index
- the index of the term
int getTermIndex(java.lang.String term)
term
- the term to get the index for
int getFrequency(int docIndex, int termIndex)
docIndex
- the index of the documenttermIndex
- the index of the term
float getScore(int docIndex, int termIndex)
docIndex
- the index of the documenttermIndex
- the index of the term
IntIterator getDocumentsFor(int termIndex)
termIndex
- the term index
DateRange getRange()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |