---

QueryServer.hpp

Go to the documentation of this file.

/*==========================================================================
 * Copyright (c) 2004 University of Massachusetts.  All Rights Reserved.
 *
 * Use of the Lemur Toolkit for Language Modeling and Information Retrieval
 * is subject to the terms of the software license set forth in the LICENSE
 * file included with this software, and also available at
 * http://www.lemurproject.org/license.html
 *
 *==========================================================================
*/


//
// QueryServer
//
// 15 March 2004 -- tds
//

#ifndef INDRI_QUERYSERVER_HPP
#define INDRI_QUERYSERVER_HPP

#include "indri/QuerySpec.hpp"
#include "indri/InferenceNetwork.hpp"
#include "indri/DocumentVector.hpp"
#include <vector>

class QueryServerResponse {
public:
  virtual InferenceNetwork::MAllResults& getResults() = 0;
};

class QueryServerDocumentsResponse {
public:
  virtual std::vector<ParsedDocument*>& getResults() = 0;
};

class QueryServerMetadataResponse {
public:
  virtual std::vector<std::string>& getResults() = 0;
};

class QueryServerVectorsResponse {
public:
  virtual std::vector<DocumentVector*>& getResults() = 0;
};

class QueryServer {
public:
  virtual ~QueryServer() {};
  virtual QueryServerResponse* runQuery( std::vector<indri::lang::Node*>& roots, int resultsRequested, bool optimize ) = 0;
  virtual QueryServerDocumentsResponse* documents( const std::vector<int>& documentIDs ) = 0;
  virtual QueryServerMetadataResponse* documentMetadata( const std::vector<int>& documentIDs, const std::string& attributeName ) = 0;

  // terms
  virtual INT64 termCount() = 0;
  virtual INT64 termCount( int term ) = 0;
  virtual INT64 termCount( const std::string& term ) = 0;
  virtual INT64 stemCount( const std::string& stem ) = 0;

  virtual std::string termName( int term ) = 0;
  virtual int termID( const std::string& term ) = 0;
  
  // fields
  virtual std::vector<std::string> fieldList() = 0;
  virtual INT64 termFieldCount( int term, const std::string& field ) = 0;
  virtual INT64 termFieldCount( const std::string& term, const std::string& field ) = 0;
  virtual INT64 stemFieldCount( const std::string& stem, const std::string& field ) = 0;

  // documents
  virtual int documentLength( int documentID ) = 0;
  virtual INT64 documentCount() = 0;
  virtual INT64 documentCount( const std::string& term ) = 0;
  
  // document vector
  virtual QueryServerVectorsResponse* documentVectors( const std::vector<int>& documentIDs ) = 0;
};

#endif // INDRI_QUERYSERVER_HPP

---