OPENTREP_Service.hpp

Go to the documentation of this file.

#ifndef __OPENTREP_SVC_OPENTREP_SERVICE_HPP
#define __OPENTREP_SVC_OPENTREP_SERVICE_HPP
 
// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <iosfwd>
#include <string>
// OpenTREP
#include <opentrep/OPENTREP_Types.hpp>
#include <opentrep/DBType.hpp>
#include <opentrep/LocationList.hpp>
#include <opentrep/DistanceErrorRule.hpp>
 
namespace OPENTREP {
 
  // Forward declaration
  class OPENTREP_ServiceContext;
 

  class OPENTREP_Service {
  public:
    // /////////// Business Methods /////////////
    NbOfDBEntries_T getIndexSize();

    NbOfMatches_T drawRandomLocations (const NbOfMatches_T& iNbOfDraws,
                                       LocationList_T&);

    NbOfMatches_T interpretTravelRequest (const std::string& iTravelQuery,
                                          LocationList_T&, WordList_T&);
 

    typedef std::pair<const TravelDBFilePath_T,
                      const SQLDBConnectionString_T> DBFilePathPair_T;
    typedef std::pair<const PORFilePath_T, const DBFilePathPair_T> FilePathSet_T;
    FilePathSet_T getFilePaths() const;

    const DeploymentNumber_T& getDeploymentNumber() const;

    bool checkXapianDBOnFileSystem (const TravelDBFilePath_T&) const;
 
  public:
    // ////////// Interaction with the SQL database //////////
    bool createSQLDBUser();

    void setSQLDBConnectString (const SQLDBConnectionString_T&);

    void createSQLDBTables();

    void createSQLDBIndexes();

    OPENTREP::DeploymentNumber_T toggleDeploymentNumber();
    
    OPENTREP::shouldIndexNonIATAPOR_T toggleShouldIncludeAllPORFlag();

    OPENTREP::shouldIndexPORInXapian_T toggleShouldIndexPORInXapianFlag();

    OPENTREP::shouldAddPORInSQLDB_T toggleShouldAddPORInSQLDBFlag();

    NbOfDBEntries_T insertIntoDBAndXapian();    

    NbOfDBEntries_T getNbOfPORFromDB();

    NbOfMatches_T listByIataCode (const IATACode_T&, LocationList_T&);

    NbOfMatches_T listByIcaoCode (const ICAOCode_T&, LocationList_T&);

    NbOfMatches_T listByFaaCode (const FAACode_T&, LocationList_T&);

    NbOfMatches_T listByUNLOCode (const UNLOCode_T&, LocationList_T&);

    NbOfMatches_T listByUICCode (const UICCode_T&, LocationList_T&);

    NbOfMatches_T listByGeonameID (const GeonamesID_T&, LocationList_T&);
 
 
  public:
    // ////////// Constructors and destructors //////////
    OPENTREP_Service (std::ostream& ioLogStream, const TravelDBFilePath_T&,
                      const DBType&, const SQLDBConnectionString_T&,
                      const DeploymentNumber_T&);

    OPENTREP_Service (std::ostream& ioLogStream, const PORFilePath_T&,
                      const TravelDBFilePath_T&, const DBType&,
                      const SQLDBConnectionString_T&, const DeploymentNumber_T&,
                      const shouldIndexNonIATAPOR_T&,
                      const shouldIndexPORInXapian_T&,
                      const shouldAddPORInSQLDB_T&);

    ~OPENTREP_Service();
 
 
  private:
    // /////// Construction and Destruction helper methods ///////
    OPENTREP_Service();
    OPENTREP_Service (const OPENTREP_Service&);

    void init (std::ostream& ioLogStream, const TravelDBFilePath_T&,
               const DBType&, const SQLDBConnectionString_T&,
               const DeploymentNumber_T&);

    void init (std::ostream& ioLogStream, const PORFilePath_T&,
               const TravelDBFilePath_T&,
               const DBType&, const SQLDBConnectionString_T&,
               const DeploymentNumber_T&, const shouldIndexNonIATAPOR_T&,
               const shouldIndexPORInXapian_T&, const shouldAddPORInSQLDB_T&);

    void finalise();
 
 
  private:
    // ///////// Service Context /////////
    OPENTREP_ServiceContext* _opentrepServiceContext;
  };
}
#endif // __OPENTREP_SVC_OPENTREP_SERVICE_HPP