---

LemurIndriIndex Class Reference

#include <LemurIndriIndex.hpp>

Inheritance diagram for LemurIndriIndex:

List of all members.

Public Methods
	LemurIndriIndex ()
	Create.
virtual	~LemurIndriIndex ()
DocInfoList *	docInfoList (TERMID_T termID) const
	doc entries in a term index with positions, See also: DocList
TermInfoList *	termInfoList (DOCID_T docID) const
	word entries in a document index (bag of words), See also: TermList
TermInfoList *	termInfoListSeq (DOCID_T docID) const
	word entries in a document index (sequence of words), See also: TermList
const DocumentManager *	docManager (DOCID_T docID) const
const string &	getRepositoryName () const
Open index
bool	open (const std::string &indexName)
	Open previously created Repository with given prefix.
bool	open (const char *indexName)
	Open previously created Repository with given prefix.
void	close ()
	close the Repository
Spelling and index conversion
TERMID_T	term (const TERM_T &word) const
	Convert a term spelling to a termID.
const TERM_T	term (TERMID_T termID) const
	Convert a termID to its spelling.
DOCID_T	document (const EXDOCID_T &docIDStr) const
	Convert a spelling to docID.
const EXDOCID_T	document (DOCID_T docID) const
	Convert a docID to its spelling.
Summary counts
COUNT_T	docCount () const
	Total count (i.e., number) of documents in collection.
COUNT_T	termCountUnique () const
	Total count of unique terms in collection.
COUNT_T	termCount (TERMID_T termID) const
	Total counts of a term in collection.
COUNT_T	termCount () const
	Total counts of all terms in collection.
float	docLengthAvg () const
	Average document length.
COUNT_T	docCount (TERMID_T termID) const
	Total counts of doc with a given term.
COUNT_T	docLength (DOCID_T documentID) const
	return length of the document

---

Detailed Description

Lemur Index API wrapper for Indri Repository.

---

Constructor & Destructor Documentation

LemurIndriIndex::LemurIndriIndex (    )

Create. Lemur Index API wrapper for Indri Repository.

LemurIndriIndex::~LemurIndriIndex (    )  [virtual]

---

Member Function Documentation

void LemurIndriIndex::close (    )

close the Repository

COUNT_T LemurIndriIndex::docCount (  TERMID_T    termID )  const [virtual]

Total counts of doc with a given term. Implements Index.

COUNT_T LemurIndriIndex::docCount (    )  [virtual]

Total count (i.e., number) of documents in collection. Implements Index.

DocInfoList * LemurIndriIndex::docInfoList (  TERMID_T    termID )  const [virtual]

doc entries in a term index with positions, See also: DocList Implements Index.

COUNT_T LemurIndriIndex::docLength (  DOCID_T    documentID )  const [virtual]

return length of the document Implements Index.

float LemurIndriIndex::docLengthAvg (    )  [virtual]

Average document length. Implements Index.

const DocumentManager* LemurIndriIndex::docManager (  DOCID_T    docID )  const [inline, virtual]

A String identifier for the document manager to get at the source of the document with this document id Reimplemented from Index.

const EXDOCID_T LemurIndriIndex::document (  DOCID_T    docID )  const [virtual]

Convert a docID to its spelling. Implements Index.

DOCID_T LemurIndriIndex::document (  const EXDOCID_T &    docIDStr )  const [virtual]

Convert a spelling to docID. Implements Index.

const string& LemurIndriIndex::getRepositoryName (    )  const [inline]

bool LemurIndriIndex::open (  const char *    indexName )  [inline]

Open previously created Repository with given prefix.

bool LemurIndriIndex::open (  const std::string &    indexName )

Open previously created Repository with given prefix.

const TERM_T LemurIndriIndex::term (  TERMID_T    termID )  const [virtual]

Convert a termID to its spelling. Implements Index.

TERMID_T LemurIndriIndex::term (  const TERM_T &    word )  const [virtual]

Convert a term spelling to a termID. Implements Index.

COUNT_T LemurIndriIndex::termCount (    )  [virtual]

Total counts of all terms in collection. Implements Index.

COUNT_T LemurIndriIndex::termCount (  TERMID_T    termID )  const [virtual]

Total counts of a term in collection. Implements Index.

COUNT_T LemurIndriIndex::termCountUnique (    )  [virtual]

Total count of unique terms in collection. Implements Index.

TermInfoList * LemurIndriIndex::termInfoList (  DOCID_T    docID )  const [virtual]

word entries in a document index (bag of words), See also: TermList Implements Index.

TermInfoList * LemurIndriIndex::termInfoListSeq (  DOCID_T    docID )  const [virtual]

word entries in a document index (sequence of words), See also: TermList Reimplemented from Index.

---

The documentation for this class was generated from the following files:

• LemurIndriIndex.hpp
• LemurIndriIndex.cpp

---