OpenTREP Logo  0.07.18
C++ Open Travel Request Parsing Library
Loading...
Searching...
No Matches
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

WorldgetWorld () const
 
WorldgetWorldHandler () const
 
const PORFilePath_TgetPORFilePath () const
 
const TravelDBFilePath_TgetTravelDBFilePath () const
 
const DBTypegetSQLDBType () const
 
const SQLDBConnectionString_TgetSQLDBConnectionString () const
 
const DeploymentNumber_TgetDeploymentNumber () const
 
const shouldIndexNonIATAPOR_TgetShouldIncludeAllPORFlag () const
 
const shouldIndexPORInXapian_TgetShouldIndexPORInXapianFlag () const
 
const shouldAddPORInSQLDB_TgetShouldAddPORInSQLDB () const
 
const OTransliteratorgetTransliterator () const
 
void setWorld (World &ioWorld)
 
void setPORFilePath (const std::string &iPORFilePath)
 
void setTravelDBFilePath (const std::string &iTravelDBFilePath)
 
void setSQLDBType (const DBType &iDBType)
 
void setSQLDBConnectionString (const std::string &iSQLDBConnStr)
 
void setDeploymentNumber (const DeploymentNumber_T &iDeploymentNumber)
 
void setShouldIncludeAllPORFlag (const shouldIndexNonIATAPOR_T &iShouldIndexNonIATAPOR)
 
void setShouldIndexPORInXapianFlag (const shouldIndexPORInXapian_T &iShouldIndexPORInXapian)
 
void setShouldAddPORInSQLDB (const shouldAddPORInSQLDB_T &iShouldAddPORInSQLDB)
 
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 28 of file OPENTREP_ServiceContext.hpp.

Member Function Documentation

◆ getWorld()

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

Get the World object (BOM root).

Definition at line 35 of file OPENTREP_ServiceContext.hpp.

◆ getWorldHandler()

World & OPENTREP::OPENTREP_ServiceContext::getWorldHandler ( ) const

Get the World object (BOM root).

Definition at line 146 of file OPENTREP_ServiceContext.cpp.

References getWorldHandler().

Referenced by getWorldHandler().

◆ getPORFilePath()

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

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

Definition at line 47 of file OPENTREP_ServiceContext.hpp.

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

◆ getTravelDBFilePath()

◆ getSQLDBType()

◆ getSQLDBConnectionString()

◆ getDeploymentNumber()

const DeploymentNumber_T & OPENTREP::OPENTREP_ServiceContext::getDeploymentNumber ( ) const
inline

◆ getShouldIncludeAllPORFlag()

const shouldIndexNonIATAPOR_T & OPENTREP::OPENTREP_ServiceContext::getShouldIncludeAllPORFlag ( ) const
inline

Get the flag stating whether or not all the POR should be indexed.

Definition at line 82 of file OPENTREP_ServiceContext.hpp.

Referenced by OPENTREP::OPENTREP_Service::insertIntoDBAndXapian(), and OPENTREP::OPENTREP_Service::toggleShouldIncludeAllPORFlag().

◆ getShouldIndexPORInXapianFlag()

const shouldIndexPORInXapian_T & OPENTREP::OPENTREP_ServiceContext::getShouldIndexPORInXapianFlag ( ) const
inline

Get the flag stating whether or not to add the POR in the Xapian index.

Definition at line 89 of file OPENTREP_ServiceContext.hpp.

Referenced by OPENTREP::OPENTREP_Service::insertIntoDBAndXapian(), and OPENTREP::OPENTREP_Service::toggleShouldIndexPORInXapianFlag().

◆ getShouldAddPORInSQLDB()

const shouldAddPORInSQLDB_T & OPENTREP::OPENTREP_ServiceContext::getShouldAddPORInSQLDB ( ) const
inline

Get the flag stating whether or not to add the POR in the SQL database.

Definition at line 96 of file OPENTREP_ServiceContext.hpp.

Referenced by OPENTREP::OPENTREP_Service::insertIntoDBAndXapian(), and OPENTREP::OPENTREP_Service::toggleShouldAddPORInSQLDBFlag().

◆ getTransliterator()

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

◆ setWorld()

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

Set the World object (BOM root).

Definition at line 112 of file OPENTREP_ServiceContext.hpp.

◆ setPORFilePath()

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 119 of file OPENTREP_ServiceContext.hpp.

◆ setTravelDBFilePath()

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

Set the Xapian database name.

Definition at line 126 of file OPENTREP_ServiceContext.hpp.

◆ setSQLDBType()

void OPENTREP::OPENTREP_ServiceContext::setSQLDBType ( const DBType & iDBType)
inline

Set the SQL database type.

Definition at line 134 of file OPENTREP_ServiceContext.hpp.

◆ setSQLDBConnectionString()

void OPENTREP::OPENTREP_ServiceContext::setSQLDBConnectionString ( const std::string & iSQLDBConnStr)
inline

Set the SQL database connection string.

Definition at line 141 of file OPENTREP_ServiceContext.hpp.

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

◆ setDeploymentNumber()

void OPENTREP::OPENTREP_ServiceContext::setDeploymentNumber ( const DeploymentNumber_T & iDeploymentNumber)
inline

Set the number/version of the current deployment.

Definition at line 149 of file OPENTREP_ServiceContext.hpp.

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

◆ setShouldIncludeAllPORFlag()

void OPENTREP::OPENTREP_ServiceContext::setShouldIncludeAllPORFlag ( const shouldIndexNonIATAPOR_T & iShouldIndexNonIATAPOR)
inline

Set the flag stating whether or not all the POR should be indexed.

Definition at line 157 of file OPENTREP_ServiceContext.hpp.

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

◆ setShouldIndexPORInXapianFlag()

void OPENTREP::OPENTREP_ServiceContext::setShouldIndexPORInXapianFlag ( const shouldIndexPORInXapian_T & iShouldIndexPORInXapian)
inline

Set the flag stating whether or not to add the POR in the Xapian index.

Definition at line 164 of file OPENTREP_ServiceContext.hpp.

◆ setShouldAddPORInSQLDB()

void OPENTREP::OPENTREP_ServiceContext::setShouldAddPORInSQLDB ( const shouldAddPORInSQLDB_T & iShouldAddPORInSQLDB)
inline

Set the flag stating whether or not to add the POR in the SQL database.

Definition at line 171 of file OPENTREP_ServiceContext.hpp.

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

◆ setTransliterator()

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

Set the Unicode transliterator.

Definition at line 178 of file OPENTREP_ServiceContext.hpp.

◆ shortDisplay()

const std::string OPENTREP::OPENTREP_ServiceContext::shortDisplay ( ) const

Display the short OPENTREP_ServiceContext content.

Definition at line 152 of file OPENTREP_ServiceContext.cpp.

References shortDisplay().

Referenced by display(), and shortDisplay().

◆ display()

◆ toStream()

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.

◆ fromStream()

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 Symbol Documentation

◆ FacOpenTrepServiceContext

friend class FacOpenTrepServiceContext
friend

Definition at line 29 of file OPENTREP_ServiceContext.hpp.

References FacOpenTrepServiceContext.

Referenced by FacOpenTrepServiceContext.


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