lemurproject::lemur::Index Class Reference

List of all members.

Public Member Functions
synchronized void	delete ()
boolean	open (String indexName) throws java.lang.Exception
int	term (String word) throws java.lang.Exception
String	term (int termID) throws java.lang.Exception
int	document (String docIDStr) throws java.lang.Exception
String	document (int docID) throws java.lang.Exception
DocumentManager	docManager (int docID) throws java.lang.Exception
int	docCount () throws java.lang.Exception
int	termCountUnique () throws java.lang.Exception
int	termCount (int termID) throws java.lang.Exception
int	termCount () throws java.lang.Exception
float	docLengthAvg () throws java.lang.Exception
int	docCount (int termID) throws java.lang.Exception
int	docLength (int docID) throws java.lang.Exception
DocInfoList	docInfoList (int termID) throws java.lang.Exception
TermInfoList	termInfoList (int docID) throws java.lang.Exception
TermInfoList	termInfoListSeq (int docID) throws java.lang.Exception
void	setProps ()
Protected Member Functions
	Index (long cPtr, boolean cMemoryOwn)
void	finalize ()
Static Protected Member Functions
long	getCPtr (Index obj)
Protected Attributes
boolean	swigCMemOwn
Private Attributes
long	swigCPtr

---

Constructor & Destructor Documentation

lemurproject::lemur::Index::Index (  long  cPtr, boolean  cMemoryOwn )  [inline, protected]

---

Member Function Documentation

synchronized void lemurproject::lemur::Index::delete (   )  [inline]

int lemurproject::lemur::Index::docCount (  int  termID  )  throws java.lang.Exception [inline]

Total counts of doc with a given term Exceptions: Exception  if a lemur::api::Exception was thrown by the JNI library.

int lemurproject::lemur::Index::docCount (   )  throws java.lang.Exception [inline]

Total count (i.e., number) of documents in collection Exceptions: Exception  if a lemur::api::Exception was thrown by the JNI library.

DocInfoList lemurproject::lemur::Index::docInfoList (  int  termID  )  throws java.lang.Exception [inline]

returns a new instance of DocInfoList which represents the doc entries in a term index. Exceptions: Exception  if a lemur::api::Exception was thrown by the JNI library.

int lemurproject::lemur::Index::docLength (  int  docID  )  throws java.lang.Exception [inline]

Total counts of terms in a document Exceptions: Exception  if a lemur::api::Exception was thrown by the JNI library.

float lemurproject::lemur::Index::docLengthAvg (   )  throws java.lang.Exception [inline]

Average document length Exceptions: Exception  if a lemur::api::Exception was thrown by the JNI library.

DocumentManager lemurproject::lemur::Index::docManager (  int  docID  )  throws java.lang.Exception [inline]

Returns: the document manager to get at the source of the document with this document id Exceptions: Exception  if a lemur::api::Exception was thrown by the JNI library.

String lemurproject::lemur::Index::document (  int  docID  )  throws java.lang.Exception [inline]

Convert a valid docID to its spelling Exceptions: Exception  if a lemur::api::Exception was thrown by the JNI library.

int lemurproject::lemur::Index::document (  String  docIDStr  )  throws java.lang.Exception [inline]

Convert a spelling to docID, returns 0 if out of vocabulary. Valid index starts at 1. Exceptions: Exception  if a lemur::api::Exception was thrown by the JNI library.

void lemurproject::lemur::Index::finalize (   )  [inline, protected]

long lemurproject::lemur::Index::getCPtr (  Index  obj  )  [inline, static, protected]

boolean lemurproject::lemur::Index::open (  String  indexName  )  throws java.lang.Exception [inline]

Open previously created Index, return true if opened successfully, indexName should be the full name of the table-of-content file for the index. E.g., index.key for a KeyfileIncIndex. Exceptions: Exception  if a lemur::api::Exception was thrown by the JNI library.

void lemurproject::lemur::Index::setProps (   )  [inline]

Loads the stemmer/stopword properties for the index.

String lemurproject::lemur::Index::term (  int  termID  )  throws java.lang.Exception [inline]

Convert a valid termID to its spelling Exceptions: Exception  if a lemur::api::Exception was thrown by the JNI library.

int lemurproject::lemur::Index::term (  String  word  )  throws java.lang.Exception [inline]

Convert a term spelling to a termID, returns 0 if out of vocabulary. Valid index starts at 1. Exceptions: Exception  if a lemur::api::Exception was thrown by the JNI library.

int lemurproject::lemur::Index::termCount (   )  throws java.lang.Exception [inline]

Total counts of all terms in collection Exceptions: Exception  if a lemur::api::Exception was thrown by the JNI library.

int lemurproject::lemur::Index::termCount (  int  termID  )  throws java.lang.Exception [inline]

Total counts of a term in collection Exceptions: Exception  if a lemur::api::Exception was thrown by the JNI library.

int lemurproject::lemur::Index::termCountUnique (   )  throws java.lang.Exception [inline]

Total count of unique terms in collection, i.e., the term vocabulary size Exceptions: Exception  if a lemur::api::Exception was thrown by the JNI library.

TermInfoList lemurproject::lemur::Index::termInfoList (  int  docID  )  throws java.lang.Exception [inline]

returns a new instance of TermInfoList which represents the word entries in a document index. Exceptions: Exception  if a lemur::api::Exception was thrown by the JNI library.

TermInfoList lemurproject::lemur::Index::termInfoListSeq (  int  docID  )  throws java.lang.Exception [inline]

returns TermInfoList is sequential representation (not bag of words) return NULL list when sequence is not available. Exceptions: Exception  if a lemur::api::Exception was thrown by the JNI library.

---

Member Data Documentation

boolean lemurproject::lemur::Index::swigCMemOwn [protected]

long lemurproject::lemur::Index::swigCPtr [private]

---

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

• Index.java

---