Main Page   Namespace List   Class Hierarchy   Compound List   File List   Compound Members  

QueryResult Class Reference

#include <QueryResult.h>

List of all members.

Public Methods

 QueryResult (Query query, vector< NumID > resultList)
 QueryResult (Query query)
Query getQuery ()
void addResult (NumID docid)
void deleteResult (NumID docid)
vector< NumID >::iterator getIterator ()


Detailed Description

Container class for Strongroom search results.


Constructor & Destructor Documentation

QueryResult::QueryResult Query    query,
vector< NumID >    resultList
 

Constructs a new QueryResult from the supplied file ID's.

Parameters:
query  the query whose results are to be contained in this QueryResult object.
resultList  a vector containing a list of the file ID's that satisfy the query.

QueryResult::QueryResult Query    query
 

Constructs a new, empty QueryResult.

Parameters:
query  the query whose results are to be contained in the QueryResult object.


Member Function Documentation

void QueryResult::addResult NumID    docid
 

Adds a document identifier to the results.

Parameters:
docid  the ID of a document that satisfies the query associated with this object.

void QueryResult::deleteResult NumID    docid
 

Deletes a docid identifier from the results.

PRE: None (the document ID does not actually have to be present in this QueryResult). POST: The supplied result is not listed in this QueryResult.

Parameters:
docid  the document ID that is to be removed from the results.

vector<NumID>::iterator QueryResult::getIterator  
 

Creates an iterator for the document ID's in this query result.

Returns:
the result iterator

Query QueryResult::getQuery  
 

Returns the query that lead to the results contained in this object.

Returns:
a Query object representing the query.


The documentation for this class was generated from the following file:
Generated on Wed Feb 18 13:45:56 2004 for strongroom by doxygen1.2.18