nominatim/data/place_info.py

   1 # SPDX-License-Identifier: GPL-2.0-only
   2 #
   3 # This file is part of Nominatim. (https://nominatim.org)
   4 #
   5 # Copyright (C) 2022 by the Nominatim developer community.
   6 # For a full list of authors see the git log.
   7 """
   8 Wrapper around place information the indexer gets from the database and hands to
   9 the tokenizer.
  10 """
  11
  12 class PlaceInfo:
  13     """ Data class containing all information the tokenizer gets about a
  14         place it should process the names for.
  15     """
  16
  17     def __init__(self, info):
  18         self._info = info
  19
  20
  21     @property
  22     def name(self):
  23         """ A dictionary with the names of the place or None if the place
  24             has no names.
  25         """
  26         return self._info.get('name')
  27
  28
  29     @property
  30     def address(self):
  31         """ A dictionary with the address elements of the place
  32             or None if no address information is available.
  33         """
  34         return self._info.get('address')
  35
  36
  37     @property
  38     def country_code(self):
  39         """ The country code of the country the place is in. Guaranteed
  40             to be a two-letter lower-case string or None, if no country
  41             could be found.
  42         """
  43         return self._info.get('country_code')
  44
  45
  46     @property
  47     def rank_address(self):
  48         """ The computed rank address before rank correction.
  49         """
  50         return self._info.get('rank_address')
  51
  52
  53     def is_a(self, key, value):
  54         """ Check if the place's primary tag corresponds to the given
  55             key and value.
  56         """
  57         return self._info.get('class') == key and self._info.get('type') == value
  58
  59
  60     def is_country(self):
  61         """ Check if the place is a valid country boundary.
  62         """
  63         return self.rank_address == 4 \
  64                and self.is_a('boundary', 'administrative') \
  65                and self.country_code is not None