Place.hpp

Go to the documentation of this file.

#ifndef __OPENTREP_BOM_PLACE_HPP
#define __OPENTREP_BOM_PLACE_HPP

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <iosfwd>
#include <string>
#include <set>
// OpenTrep
#include <opentrep/OPENTREP_Types.hpp>
#include <opentrep/NameMatrix.hpp>
#include <opentrep/Location.hpp>
#include <opentrep/bom/BomAbstract.hpp>
#include <opentrep/bom/PlaceList.hpp>

namespace OPENTREP {

  // Forward declarations
  class World;
  class PlaceHolder;
  struct OTransliterator;
  
  class Place : public BomAbstract {
    friend class FacWorld;
    friend class FacPlace;
    friend class FacPlaceHolder;
    friend class DbaPlace;
  public:
    // /////////// Type definitions //////////
    typedef std::set<std::string> StringSet_T;
    typedef std::map<const Weight_T, StringSet_T> TermSetMap_T;


  public:
    // //////////////// Getters ///////////////
    const Location& getLocation() const {
      return _location;
    }

    const LocationKey& getKey() const {
      return _location.getKey();
    }
    
    const IATACode_T& getIataCode() const {
      return _location.getIataCode();
    }
    
    const IATAType& getIataType() const {
      return _location.getIataType();
    }

    const GeonamesID_T& getGeonamesID() const {
      return _location.getGeonamesID();
    }

    const IsGeonames_T& isGeonames() const {
      return _location.isGeonames();
    }

    const ICAOCode_T& getIcaoCode() const {
      return _location.getIcaoCode();
    }
    
    const FAACode_T& getFaaCode() const {
      return _location.getFaaCode();
    }
    
    const CommonName_T& getCommonName() const {
      return _location.getCommonName();
    }
    
    const ASCIIName_T& getAsciiName() const {
      return _location.getAsciiName();
    }
    
    const AltNameShortListString_T& getAltNameShortListString() const {
      return _location.getAltNameShortListString();
    }

    const EnvelopeID_T& getEnvelopeID() const {
      return _location.getEnvelopeID();
    }

    const Date_T& getDateFrom() const {
      return _location.getDateFrom();
    }

    const Date_T& getDateEnd() const {
      return _location.getDateEnd();
    }

    const Comment_T& getComment() const {
      return _location.getComment();
    }

    const CityCode_T& getCityCode() const {
      return _location.getCityCode();
    }

    const CityUTFName_T& getCityUtfName() const {
      return _location.getCityUtfName();
    }
    
    const CityASCIIName_T& getCityAsciiName() const {
      return _location.getCityAsciiName();
    }
    
    const GeonamesID_T& getCityGeonamesID() const {
      return _location.getCityGeonamesID();
    }

    const StateCode_T& getStateCode() const {
      return _location.getStateCode();
    }
    
    const CountryCode_T& getCountryCode() const {
      return _location.getCountryCode();
    }
    
    const AltCountryCode_T& getAltCountryCode() const {
      return _location.getAltCountryCode();
    }
    
    const CountryName_T& getCountryName() const {
      return _location.getCountryName();
    }
    
    const ContinentCode_T& getContinentCode() const {
      return _location.getContinentCode();
    }
    
    const ContinentName_T& getContinentName() const {
      return _location.getContinentName();
    }
    
    const TimeZone_T& getTimeZone() const {
      return _location.getTimeZone();
    }
    
    const GMTOffset_T& getGMTOffset() const {
      return _location.getGMTOffset();
    }

    const DSTOffset_T& getDSTOffset() const {
      return _location.getDSTOffset();
    }

    const RawOffset_T& getRawOffset() const {
      return _location.getRawOffset();
    }

    const Latitude_T& getLatitude() const {
      return _location.getLatitude();
    }

    const Longitude_T& getLongitude() const {
      return _location.getLongitude();
    }
    
    const FeatureClass_T& getFeatureClass() const {
      return _location.getFeatureClass();
    }

    const FeatureCode_T& getFeatureCode() const {
      return _location.getFeatureCode();
    }

    const Admin1Code_T& getAdmin1Code() const {
      return _location.getAdmin1Code();
    }

    const Admin1UTFName_T& getAdmin1UtfName() const {
      return _location.getAdmin1UtfName();
    }

    const Admin1ASCIIName_T& getAdmin1AsciiName() const {
      return _location.getAdmin1AsciiName();
    }

    const Admin2Code_T& getAdmin2Code() const {
      return _location.getAdmin2Code();
    }

    const Admin2UTFName_T& getAdmin2UtfName() const {
      return _location.getAdmin2UtfName();
    }

    const Admin2ASCIIName_T& getAdmin2AsciiName() const {
      return _location.getAdmin2AsciiName();
    }

    const Admin3Code_T& getAdmin3Code() const {
      return _location.getAdmin3Code();
    }

    const Admin4Code_T& getAdmin4Code() const {
      return _location.getAdmin4Code();
    }

    const Population_T& getPopulation() const {
      return _location.getPopulation();
    }

    const Elevation_T& getElevation() const {
      return _location.getElevation();
    }

    const GTopo30_T& getGTopo30() const {
      return _location.getGTopo30();
    }

    const PageRank_T& getPageRank() const {
      return _location.getPageRank();
    }
    
    const Date_T& getModificationDate() const {
      return _location.getModificationDate();
    }
    
    const WikiLink_T& getWikiLink() const {
      return _location.getWikiLink();
    }
    
    const NameMatrix& getNameMatrix() const {
      return _location.getNameMatrix();
    }

    bool getNameList (const LanguageCode_T& iLanguageCode,
                      NameList_T& ioNameList) const {
      return _location.getNameList (iLanguageCode, ioNameList);
    }

    const std::string& getOriginalKeywords() const {
      return _location.getOriginalKeywords();
    }
    
    const std::string& getCorrectedKeywords() const {
      return _location.getCorrectedKeywords();
    }
    
    const MatchingPercentage_T& getPercentage() const {
      return _location.getPercentage();
    }

    const NbOfErrors_T& getEditDistance() const {
      return _location.getEditDistance();
    }

    const NbOfErrors_T& getAllowableEditDistance() const {
      return _location.getAllowableEditDistance();
    }

    const RawDataString_T& getRawDataString() const {
      return _location.getRawDataString();
    }

    const XapianDocID_T& getDocID() const {
      return _docID;
    }

    const PlaceOrderedList_T& getExtraPlaceList() const {
      return _extraPlaceList;
    }

    const PlaceOrderedList_T& getAlternatePlaceList() const {
      return _alternatePlaceList;
    }

    const TermSetMap_T& getTermSetMap() const {
      return _termSetMap;
    }

    StringSet_T getTermSet (const Weight_T&) const;

    const StringSet_T& getSpellingSet() const {
      return _spellingSet;
    }

    const StringSet_T& getStemmingSet() const {
      return _stemmingSet;
    }

    const StringSet_T& getSynonymSet() const {
      return _synonymSet;
    }


  public:
    // ////////////////// Setters /////////////////
    void setLocation (const Location& iLocation) {
      _location = iLocation;
    }
    
    void setKey (const LocationKey& iKey) {
      _location.setKey (iKey);
    }
    
    void setIataCode (const std::string& iIataCode) {
      _location.setIataCode (iIataCode);
    }
    
    void setIataType (const std::string& iIATAType) {
      _location.setIataType (iIATAType);
    }

    void setGeonamesID (const GeonamesID_T& iGeonamesID) {
      _location.setGeonamesID (iGeonamesID);
    }

    void setIcaoCode (const std::string& iIcaoCode) {
      _location.setIcaoCode (iIcaoCode);
    }
    
    void setFaaCode (const std::string& iFaaCode) {
      _location.setFaaCode (iFaaCode);
    }
    
    void setCommonName (const std::string& iName) {
      _location.setCommonName (iName);
    }
    
    void setAsciiName (const std::string& iName) {
      _location.setAsciiName (iName);
    }
    
    void setAltNameShortListString (const std::string& iNameListString) {
      _location.setAltNameShortListString (iNameListString);
    }

    void setEnvelopeID (const EnvelopeID_T& iEnvelopeID) {
      _location.setEnvelopeID (iEnvelopeID);
    }

    void setDateFrom (const Date_T& iDate) {
      _location.setDateFrom (iDate);
    }

    void setDateEnd (const Date_T& iDate) {
      _location.setDateEnd (iDate);
    }

    void setComment (const std::string& iComment) {
      _location.setComment (iComment);
    }

    void setCityCode (const std::string& iCityCode) {
      _location.setCityCode (iCityCode);
    }
    
    void setCityUtfName (const std::string& iCityUtfName) {
      _location.setCityUtfName (iCityUtfName);
    }
    
    void setCityAsciiName (const std::string& iCityAsciiName) {
      _location.setCityAsciiName (iCityAsciiName);
    }
    
    void setCityGeonamesID (const GeonamesID_T& iGeonamesID) {
      _location.setCityGeonamesID (iGeonamesID);
    }

    void setStateCode (const std::string& iStateCode) {
      _location.setStateCode (iStateCode);
    }
    
    void setCountryCode (const std::string& iCountryCode) {
      _location.setCountryCode (iCountryCode);
    }
    
    void setAltCountryCode (const std::string& iCountryCode) {
      _location.setAltCountryCode (iCountryCode);
    }
    
    void setCountryName (const std::string& iCountryName) {
      _location.setCountryName (iCountryName);
    }
    
    void setContinentCode (const std::string& iContinentCode) {
      _location.setContinentCode (iContinentCode);
    }
    
    void setContinentName (const std::string& iContinentName) {
      _location.setContinentName (iContinentName);
    }
    
    void setTimeZone (const std::string& iTimeZone) {
      _location.setTimeZone (iTimeZone);
    }
    
    void setGMTOffset (const GMTOffset_T& iOffset) {
      _location.setGMTOffset (iOffset);
    }

    void setDSTOffset (const DSTOffset_T& iOffset) {
      _location.setDSTOffset (iOffset);
    }

    void setRawOffset (const RawOffset_T& iOffset) {
      _location.setRawOffset (iOffset);
    }

    void setLatitude (const Latitude_T& iLatitude) {
      _location.setLatitude (iLatitude);
    }

    void setLongitude (const Longitude_T& iLongitude) {
      _location.setLongitude (iLongitude);
    }
    
    void setFeatureClass (const std::string& iFeatClass) {
      _location.setFeatureClass (iFeatClass);
    }

    void setFeatureCode (const std::string& iFeatCode) {
      _location.setFeatureCode (iFeatCode);
    }

    void setAdmin1Code (const std::string& iAdminCode) {
      _location.setAdmin1Code (iAdminCode);
    }

    void setAdmin1UtfName (const std::string& iAdminName) {
      _location.setAdmin1UtfName (iAdminName);
    }

    void setAdmin1AsciiName (const std::string& iAdminName) {
      _location.setAdmin1AsciiName (iAdminName);
    }

    void setAdmin2Code (const std::string& iAdminCode) {
      _location.setAdmin2Code (iAdminCode);
    }

    void setAdmin2UtfName (const std::string& iAdminName) {
      _location.setAdmin2UtfName (iAdminName);
    }

    void setAdmin2AsciiName (const std::string& iAdminName) {
      _location.setAdmin2AsciiName (iAdminName);
    }

    void setAdmin3Code (const std::string& iAdminCode) {
      _location.setAdmin3Code (iAdminCode);
    }

    void setAdmin4Code (const std::string& iAdminCode) {
      _location.setAdmin4Code (iAdminCode);
    }

    void setPopulation (const Population_T& iPopulation) {
      _location.setPopulation (iPopulation);
    }

    void setElevation (const Elevation_T& iElevation) {
      _location.setElevation (iElevation);
    }

    void setGTopo30 (const GTopo30_T& iGTopo30) {
      _location.setGTopo30 (iGTopo30);
    }

    void setPageRank (const PageRank_T& iPageRank) {
      _location.setPageRank (iPageRank);
    }
    
    void setModificationDate (const Date_T& iModDate) {
      _location.setModificationDate (iModDate);
    }

    void setWikiLink (const std::string& iWikiLink) {
      _location.setWikiLink (iWikiLink);
    }
    
    void setOriginalKeywords (const std::string& iOriginalKeywords) {
      _location.setOriginalKeywords (iOriginalKeywords);
    }
    
    void setCorrectedKeywords (const std::string& iCorrectedKeywords) {
      _location.setCorrectedKeywords (iCorrectedKeywords);
    }
    
    void setPercentage (const MatchingPercentage_T& iPercentage) {
      _location.setPercentage (iPercentage);
    }

    void setEditDistance (const NbOfErrors_T& iEditDistance) {
      _location.setEditDistance (iEditDistance);
    }

    void setAllowableEditDistance (const NbOfErrors_T& iAllowableEditDistance) {
      _location.setAllowableEditDistance (iAllowableEditDistance);
    }

    void setRawDataString (const std::string& iRawDataString) {
      _location.setRawDataString (iRawDataString);
    }

    void setDocID (const XapianDocID_T& iDocID) {
      _docID = iDocID;
    }

    bool addTermSet (const Weight_T&, const StringSet_T&);

    
  public:
    // ////////// Setters in underlying names ////////
    void addName (const LanguageCode_T& iLanguageCode,
                  const std::string& iName) {
      _location.addName (iLanguageCode, iName);
    }

    void resetMatrix() {
      _location.resetMatrix();
    }

    void resetIndexSets();

    
  public:
    // /////////// Business methods /////////
    const Location& completeLocation();

    void addNameToXapianSets (const Weight_T&,
                              const LocationName_T&, const FeatureCode_T&,
                              const CityUTFName_T&, const CityASCIIName_T&,
                              const Admin1UTFName_T&, const Admin1ASCIIName_T&,
                              const Admin2UTFName_T&, const Admin2ASCIIName_T&,
                              const StateCode_T&,
                              const CountryCode_T&, const CountryName_T&,
                              const ContinentName_T&, const OTransliterator&);

    void buildIndexSets (const OTransliterator&);

    void addNameToXapianSets (const Weight_T&, const std::string& iBaseName,
                              const FeatureCode_T&);


  public:
    // ///////// Display methods ////////
    void toStream (std::ostream&) const;

    void fromStream (std::istream&);

    std::string describeKey() const {
      return _location.describeKey();
    }

    std::string describeShortKey() const {
      return _location.describeShortKey();
    }
    
    std::string toString() const;

    std::string toShortString() const;
    
    std::string describeSets() const;

    std::string display() const;

    std::string shortDisplay() const;

    
  private:
    Place (const LocationKey&);

    Place (const Location&);

    Place();

    Place (const Place&);
    
    virtual ~Place();


  private:
    // ////////////////////// Parent objects ////////////////////
    World* _world;
    
    PlaceHolder* _placeHolder;
    
    Place* _mainPlace;

    
  private:
    // ///////////////// Attributes ///////////////////////
    Location _location;

    
  private:
    // ///////////// Full-text matching process support attributes //////////
    XapianDocID_T _docID;

    PlaceOrderedList_T _extraPlaceList;

    PlaceOrderedList_T _alternatePlaceList;

    TermSetMap_T _termSetMap;

    StringSet_T _spellingSet;

    StringSet_T _stemmingSet;

    StringSet_T _synonymSet;
  };

}
#endif // __OPENTREP_BOM_PLACE_HPP