LocationService.h

Go to the documentation of this file.

#ifndef OSMSCOUT_LOCATIONSERVICE_H
#define OSMSCOUT_LOCATIONSERVICE_H

/*
  This source is part of the libosmscout library
  Copyright (C) 2009  Tim Teulings

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
*/

#include <list>
#include <memory>

#include <osmscout/Database.h>
#include <osmscout/Location.h>

#include <osmscout/util/StringMatcher.h>
#include <osmscout/util/Breaker.h>

namespace osmscout {

  class OSMSCOUT_API POIFormSearchParameter CLASS_FINAL
  {
  private:
    std::string             adminRegionSearchString; 
    std::string             poiSearchString;         

    bool                    adminRegionOnlyMatch;    
    bool                    poiOnlyMatch;            

    bool                    partialMatch;            

    StringMatcherFactoryRef stringMatcherFactory;    

    size_t                  limit;                   

    BreakerRef              breaker;                 
  public:
    explicit POIFormSearchParameter();

    std::string GetAdminRegionSearchString() const;
    std::string GetPOISearchString() const;

    bool GetAdminRegionOnlyMatch() const;
    bool GetPOIOnlyMatch() const;

    bool GetPartialMatch() const;

    StringMatcherFactoryRef GetStringMatcherFactory() const;

    size_t GetLimit() const;

    void SetStringMatcherFactory(const StringMatcherFactoryRef& stringMatcherFactory);

    void SetAdminRegionSearchString(const std::string& adminRegionSearchString);
    void SetPOISearchString(const std::string& poiSearchString);

    void SetAdminRegionOnlyMatch(bool adminRegionOnlyMatch);
    void SetPOIOnlyMatch(bool poiOnlyMatch);

    void SetPartialMatch(bool partialMatch);

    void SetLimit(size_t limit);

    void SetBreaker(BreakerRef &breaker);
    BreakerRef GetBreaker() const;
    bool IsAborted() const;
  };

  class OSMSCOUT_API LocationFormSearchParameter CLASS_FINAL
  {
  private:
    std::string             adminRegionSearchString; 
    std::string             postalAreaSearchString;  
    std::string             locationSearchString;    
    std::string             addressSearchString;     

    bool                    adminRegionOnlyMatch;    
    bool                    postalAreaOnlyMatch;     
    bool                    locationOnlyMatch;       
    bool                    addressOnlyMatch;        

    bool                    partialMatch;            

    StringMatcherFactoryRef stringMatcherFactory;    
    size_t                  limit;                   

    BreakerRef              breaker;                 
  public:
    explicit LocationFormSearchParameter();

    std::string GetAdminRegionSearchString() const;
    std::string GetPostalAreaSearchString() const;
    std::string GetLocationSearchString() const;
    std::string GetAddressSearchString() const;

    bool GetAdminRegionOnlyMatch() const;
    bool GetPostalAreaOnlyMatch() const;
    bool GetLocationOnlyMatch() const;
    bool GetAddressOnlyMatch() const;

    bool GetPartialMatch() const;

    StringMatcherFactoryRef GetStringMatcherFactory() const;

    size_t GetLimit() const;

    void SetStringMatcherFactory(const StringMatcherFactoryRef& stringMatcherFactory);

    void SetAdminRegionSearchString(const std::string& adminRegionSearchString);
    void SetPostalAreaSearchString(const std::string& postalAreaSearchString);
    void SetLocationSearchString(const std::string& locationSearchString);
    void SetAddressSearchString(const std::string& addressSearchString);

    void SetAdminRegionOnlyMatch(bool adminRegionOnlyMatch);
    void SetPostalAreaOnlyMatch(bool postalAreaOnlyMatch);
    void SetLocationOnlyMatch(bool locationOnlyMatch);
    void SetAddressOnlyMatch(bool addressOnlyMatch);

    void SetPartialMatch(bool partialMatch);

    void SetLimit(size_t limit);

    void SetBreaker(BreakerRef &breaker);
    BreakerRef GetBreaker() const;
    bool IsAborted() const;
  };

  class OSMSCOUT_API LocationStringSearchParameter CLASS_FINAL
  {
  private:
    AdminRegionRef          defaultAdminRegion;          

    bool                    searchForLocation=true;      
    bool                    searchForPOI=true;           

    bool                    adminRegionOnlyMatch=false;  
    bool                    poiOnlyMatch=false;          
    bool                    locationOnlyMatch=false;     
    bool                    addressOnlyMatch=false;      

    bool                    partialMatch=false;          

    std::string             searchString;                
    StringMatcherFactoryRef stringMatcherFactory;        

    size_t                  limit=100;                   

    BreakerRef              breaker;                     

  public:
    explicit LocationStringSearchParameter(const std::string& searchString);

    AdminRegionRef GetDefaultAdminRegion() const;

    bool GetSearchForLocation() const;
    bool GetSearchForPOI() const;

    bool GetAdminRegionOnlyMatch() const;
    bool GetPOIOnlyMatch() const;
    bool GetLocationOnlyMatch() const;
    bool GetAddressOnlyMatch() const;

    bool GetPartialMatch() const;

    std::string GetSearchString() const;

    StringMatcherFactoryRef GetStringMatcherFactory() const;

    size_t GetLimit() const;

    void SetDefaultAdminRegion(const AdminRegionRef& adminRegion);

    void SetSearchForLocation(bool searchForLocation);
    void SetSearchForPOI(bool searchForPOI);

    void SetAdminRegionOnlyMatch(bool adminRegionOnlyMatch);
    void SetPOIOnlyMatch(bool poiOnlyMatch);
    void SetLocationOnlyMatch(bool locationOnlyMatch);
    void SetAddressOnlyMatch(bool addressOnlyMatch);

    void SetPartialMatch(bool partialMatch);

    void SetStringMatcherFactory(const StringMatcherFactoryRef& stringMatcherFactory);

    void SetLimit(size_t limit);

    void SetBreaker(BreakerRef &breaker);
    BreakerRef GetBreaker() const;
    bool IsAborted() const;
  };

  class OSMSCOUT_API LocationSearchResult
  {
  public:

    enum MatchQuality {
      match     = 1,
      candidate = 2,
      none      = 3
    };

    class OSMSCOUT_API Entry
    {
    public:
      AdminRegionRef adminRegion;
      MatchQuality   adminRegionMatchQuality;
      PostalAreaRef  postalArea;
      MatchQuality   postalAreaMatchQuality;
      LocationRef    location;
      MatchQuality   locationMatchQuality;
      POIRef         poi;
      MatchQuality   poiMatchQuality;
      AddressRef     address;
      MatchQuality   addressMatchQuality;

      bool operator<(const Entry& other) const;
      bool operator==(const Entry& other) const;
    };

  public:
    std::list<Entry> results;
    bool             limitReached;
  };

  class OSMSCOUT_API LocationService
  {
  private:
    DatabaseRef database;

  public:
    explicit LocationService(const DatabaseRef& database);

    bool VisitAdminRegions(AdminRegionVisitor& visitor) const;

    bool ResolveAdminRegionHierachie(const AdminRegionRef& adminRegion,
                                     std::map<FileOffset,AdminRegionRef >& refs) const;

    bool VisitAdminRegionLocations(const AdminRegion& region,
                                   const PostalArea& postalArea,
                                   LocationVisitor& visitor) const;

    bool VisitAdminRegionPOIs(const AdminRegion& region,
                              POIVisitor& visitor) const;

    bool VisitLocationAddresses(const AdminRegion& region,
                                const PostalArea& postalArea,
                                const Location& location,
                                AddressVisitor& visitor) const;

    bool SearchForLocationByString(const LocationStringSearchParameter& searchParameter,
                                   LocationSearchResult& result) const;

    bool SearchForLocationByForm(const LocationFormSearchParameter& searchParameter,
                                 LocationSearchResult& result) const;

    bool SearchForPOIByForm(const POIFormSearchParameter& searchParameter,
                            LocationSearchResult& result) const;

  };

  using LocationServiceRef = std::shared_ptr<LocationService>;
}


#endif