Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Repository Class Reference

#include <Repository.hpp>

List of all members.

Public Methods

 Repository ()
 ~Repository ()
void addDocument (ParsedDocument *document)
const std::vector< Field > & fields () const
 
Returns:
the indexed fields for this collection


std::vector< std::string > tags () const
 
Returns:
the tags for this collection


std::string processTerm (const std::string &term)
CompressedCollectioncollection ()
 
Returns:
the compressed document collection


IndriIndexindex ()
 
Returns:
the indri document index


void create (const std::string &path, Parameters *options=0)
void open (const std::string &path, Parameters *options=0)
void openRead (const std::string &path, Parameters *options=0)
void close ()
 Close the repository.


Static Public Methods

bool exists (const std::string &path)


Detailed Description

Encapsulates document manager, index, and field indexes. Provides access to collection for both IndexEnvironment and QueryEnvironment.


Constructor & Destructor Documentation

Repository::Repository   [inline]
 

Repository::~Repository   [inline]
 


Member Function Documentation

void Repository::addDocument ParsedDocument   document
 

add a parsed document to the repository.

Parameters:
document  the document to add.

void Repository::close  
 

Close the repository.

CompressedCollection * Repository::collection  
 

Returns:
the compressed document collection

void Repository::create const std::string &    path,
Parameters   options = 0
 

Create a new empty repository.

Parameters:
path  the directory to create the repository in
options  additional parameters

bool Repository::exists const std::string &    path [static]
 

Returns:
true if a valid Indri Repository resides in the named path false otherwise.
Parameters:
path  the directory to open the repository from

const std::vector< Repository::Field > & Repository::fields  
 

Returns:
the indexed fields for this collection

IndriIndex * Repository::index  
 

Returns:
the indri document index

void Repository::open const std::string &    path,
Parameters   options = 0
 

Open an existing repository.

Parameters:
path  the directory to open the repository from
options  additional parameters

void Repository::openRead const std::string &    path,
Parameters   options = 0
 

Open an existing repository in read only mode.

Parameters:
path  the directory to open the repository from
options  additional parameters

std::string Repository::processTerm const std::string &    term
 

Process, possibly transforming, the given term

Parameters:
term  the term to process
Returns:
the processed term

std::vector< std::string > Repository::tags  
 

Returns:
the tags for this collection


The documentation for this class was generated from the following files:
Generated on Wed Nov 3 12:59:53 2004 for Lemur Toolkit by doxygen1.2.18