OPENTREP::OPENTREP_ServiceContext Class Reference

Class holding the context of the OpenTrep services. More...

#include <opentrep/service/OPENTREP_ServiceContext.hpp>

Inheritance diagram for OPENTREP::OPENTREP_ServiceContext:

Public Member Functions
World *	getWorld () const
World &	getWorldHandler () const
const PORFilePath_T &	getPORFilePath () const
const TravelDBFilePath_T &	getTravelDBFilePath () const
const SQLiteDBFilePath_T &	getSQLiteDBFilePath () const
const OTransliterator &	getTransliterator () const
void	setWorld (World &ioWorld)
void	setPORFilePath (const std::string &iPORFilePath)
void	setTravelDBFilePath (const std::string &iTravelDBFilePath)
void	setSQLiteDBFilePath (const std::string &iSQLiteDBFilePath)
void	setTransliterator (const OTransliterator &iTransliterator)
const std::string	shortDisplay () const
const std::string	display () const
virtual void	toStream (std::ostream &ioOut) const
virtual void	fromStream (std::istream &ioIn)

Friends
class	FacOpenTrepServiceContext

Detailed Description

Class holding the context of the OpenTrep services.

Definition at line 27 of file OPENTREP_ServiceContext.hpp.

Member Function Documentation

World* OPENTREP::OPENTREP_ServiceContext::getWorld ( ) const

inline

Get the World object (BOM root).

Definition at line 34 of file OPENTREP_ServiceContext.hpp.

World & OPENTREP::OPENTREP_ServiceContext::getWorldHandler

(

)

const

Get the World object (BOM root).

Definition at line 49 of file OPENTREP_ServiceContext.cpp.

const PORFilePath_T& OPENTREP::OPENTREP_ServiceContext::getPORFilePath ( ) const

inline

Get the file-path of the file of POR (points of reference).

Definition at line 46 of file OPENTREP_ServiceContext.hpp.

Referenced by OPENTREP::OPENTREP_Service::buildSearchIndex(), OPENTREP::OPENTREP_Service::buildSQLDB(), and OPENTREP::OPENTREP_Service::getFilePaths().

const TravelDBFilePath_T& OPENTREP::OPENTREP_ServiceContext::getTravelDBFilePath ( ) const

inline

Get the Xapian database name.

Definition at line 53 of file OPENTREP_ServiceContext.hpp.

Referenced by OPENTREP::OPENTREP_Service::buildSearchIndex(), OPENTREP::OPENTREP_Service::drawRandomLocations(), OPENTREP::OPENTREP_Service::getFilePaths(), OPENTREP::OPENTREP_Service::getIndexSize(), and OPENTREP::OPENTREP_Service::interpretTravelRequest().

const SQLiteDBFilePath_T& OPENTREP::OPENTREP_ServiceContext::getSQLiteDBFilePath ( ) const

inline

Get the SQLite3 database file-path.

Definition at line 60 of file OPENTREP_ServiceContext.hpp.

Referenced by OPENTREP::OPENTREP_Service::buildSQLDB(), and OPENTREP::OPENTREP_Service::getFilePaths().

const OTransliterator& OPENTREP::OPENTREP_ServiceContext::getTransliterator ( ) const

inline

Get the Unicode transliterator.

Definition at line 67 of file OPENTREP_ServiceContext.hpp.

Referenced by OPENTREP::OPENTREP_Service::buildSearchIndex().

void OPENTREP::OPENTREP_ServiceContext::setWorld ( World &  ioWorld )

inline

Set the World object (BOM root).

Definition at line 76 of file OPENTREP_ServiceContext.hpp.

void OPENTREP::OPENTREP_ServiceContext::setPORFilePath ( const std::string &  iPORFilePath )

inline

Set the file-path of the file of POR (points of reference).

Definition at line 83 of file OPENTREP_ServiceContext.hpp.

void OPENTREP::OPENTREP_ServiceContext::setTravelDBFilePath ( const std::string &  iTravelDBFilePath )

inline

Set the Xapian database name.

Definition at line 90 of file OPENTREP_ServiceContext.hpp.

void OPENTREP::OPENTREP_ServiceContext::setSQLiteDBFilePath ( const std::string &  iSQLiteDBFilePath )

inline

Set the SQLite3 database file-path.

Definition at line 97 of file OPENTREP_ServiceContext.hpp.

void OPENTREP::OPENTREP_ServiceContext::setTransliterator ( const OTransliterator &  iTransliterator )

inline

Set the Unicode transliterator.

Definition at line 104 of file OPENTREP_ServiceContext.hpp.

const std::string OPENTREP::OPENTREP_ServiceContext::shortDisplay

(

)

const

Display the short OPENTREP_ServiceContext content.

Definition at line 55 of file OPENTREP_ServiceContext.cpp.

Referenced by display().

const std::string OPENTREP::OPENTREP_ServiceContext::display

(

)

const

Display the full OPENTREP_ServiceContext content.

Definition at line 66 of file OPENTREP_ServiceContext.cpp.

References OPENTREP::World::display(), and shortDisplay().

Referenced by OPENTREP::OPENTREP_Service::buildSearchIndex(), OPENTREP::OPENTREP_Service::buildSQLDB(), OPENTREP::OPENTREP_Service::drawRandomLocations(), OPENTREP::OPENTREP_Service::getIndexSize(), and OPENTREP::OPENTREP_Service::interpretTravelRequest().

virtual void OPENTREP::ServiceAbstract::toStream ( std::ostream &  ioOut ) const

inlinevirtualinherited

Dump a Business Object into an output stream.

Parameters

ostream&

the output stream.

Definition at line 22 of file ServiceAbstract.hpp.

virtual void OPENTREP::ServiceAbstract::fromStream ( std::istream &  ioIn )

inlinevirtualinherited

Read a Business Object from an input stream.

Parameters

istream&

the input stream.

Definition at line 26 of file ServiceAbstract.hpp.

Referenced by operator>>().

Friends And Related Function Documentation

friend class FacOpenTrepServiceContext

friend

Definition at line 28 of file OPENTREP_ServiceContext.hpp.

---

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

• opentrep/service/OPENTREP_ServiceContext.hpp
• opentrep/service/OPENTREP_ServiceContext.cpp