Merge pull request #2957 from lonvia/reorganise-api-module

[nominatim.git] / settings / flex-base.lua

diff --git a/settings/flex-base.lua b/settings/flex-base.lua
index f508b98a123342b64b9b438c61d0f51932580b02..0e11273633cfc6dabcda67b1f3f1f50954527fe8 100644 (file)
--- a/settings/flex-base.lua
+++ b/settings/flex-base.lua
@@ -3,8 +3,17 @@
 
 local module = {}
 
 
 local module = {}
 

+local PRE_DELETE = nil
+local PRE_EXTRAS = nil
+local MAIN_KEYS = nil
+local NAMES = nil
+local ADDRESS_TAGS = nil
+local SAVE_EXTRA_MAINS = false
+local POSTCODE_FALLBACK = true
+
+

 -- The single place table.
 -- The single place table.

-place_table = osm2pgsql.define_table{
+local place_table = osm2pgsql.define_table{

     name = "place",
     ids = { type = 'any', id_column = 'osm_id', type_column = 'osm_type' },
     columns = {
     name = "place",
     ids = { type = 'any', id_column = 'osm_id', type_column = 'osm_type' },
     columns = {


@@ -19,6 +28,23 @@ place_table = osm2pgsql.define_table{
     indexes = {}
 }
 
     indexes = {}
 }
 

+------------ Geometry functions for relations ---------------------
+
+function module.relation_as_multipolygon(o)
+    return o:as_multipolygon()
+end
+
+function module.relation_as_multiline(o)
+    return o:as_multilinestring():line_merge()
+end
+
+
+module.RELATION_TYPES = {
+    multipolygon = module.relation_as_multipolygon,
+    boundary = module.relation_as_multipolygon,
+    waterway = module.relation_as_multiline
+}
+

 ------------- Place class ------------------------------------------
 
 local Place = {}
 ------------- Place class ------------------------------------------
 
 local Place = {}


@@ -46,14 +72,12 @@ function Place.new(object, geom_func)
 end
 
 function Place:clean(data)
 end
 
 function Place:clean(data)

-    if data.delete ~= nil or data.extra ~= nil then
-        for k, v in pairs(self.object.tags) do
-            if data.delete ~= nil and data.delete(k, v) then
-                self.object.tags[k] = nil
-            elseif data.extra ~= nil and data.extra(k, v) then
-                self.extratags[k] = v
-                self.object.tags[k] = nil
-            end
+    for k, v in pairs(self.object.tags) do
+        if data.delete ~= nil and data.delete(k, v) then
+            self.object.tags[k] = nil
+        elseif data.extra ~= nil and data.extra(k, v) then
+            self.extratags[k] = v
+            self.object.tags[k] = nil

         end
     end
 end
         end
     end
 end


@@ -84,38 +108,6 @@ function Place:grab_extratags(data)
     return count
 end
 
     return count
 end
 

-function Place:grab_address(data)
-    local count = 0
-
-    if data.match ~= nil then
-        for k, v in pairs(self.object.tags) do
-            if data.match(k, v) then
-                self.object.tags[k] = nil
-
-                if data.include_on_name == true then
-                    self.has_name = true
-                end
-
-                if data.out_key ~= nil then
-                    self.address[data.out_key] = v
-                    return 1
-                end
-
-                if k:sub(1, 5) == 'addr:' then
-                    self.address[k:sub(6)] = v
-                elseif k:sub(1, 6) == 'is_in:' then
-                    self.address[k:sub(7)] = v
-                else
-                    self.address[k] = v
-                end
-                count = count + 1
-            end
-        end
-    end
-
-    return count
-end
-

 local function strip_address_prefix(k)
     if k:sub(1, 5) == 'addr:' then
         return k:sub(6)
 local function strip_address_prefix(k)
     if k:sub(1, 5) == 'addr:' then
         return k:sub(6)


@@ -154,24 +146,6 @@ function Place:grab_address_parts(data)
     return count
 end
 
     return count
 end
 

-function Place:grab_name(data)
-    local count = 0
-
-    if data.match ~= nil then
-        for k, v in pairs(self.object.tags) do
-            if data.match(k, v) then
-                self.object.tags[k] = nil
-                self.names[k] = v
-                if data.include_on_name ~= false then
-                    self.has_name = true
-                end
-                count = count + 1
-            end
-        end
-    end
-
-    return count
-end

 
 function Place:grab_name_parts(data)
     local fallback = nil
 
 function Place:grab_name_parts(data)
     local fallback = nil


@@ -182,6 +156,7 @@ function Place:grab_name_parts(data)
 
             if atype ~= nil then
                 self.names[k] = v
 
             if atype ~= nil then
                 self.names[k] = v

+                self.object.tags[k] = nil

                 if atype == 'main' then
                     self.has_name = true
                 elseif atype == 'house' then
                 if atype == 'main' then
                     self.has_name = true
                 elseif atype == 'house' then


@@ -195,9 +170,6 @@ function Place:grab_name_parts(data)
     return fallback
 end
 
     return fallback
 end
 

-function Place:grab_tag(key)
-    return self.object:grab_tag(key)
-end

 
 function Place:write_place(k, v, mtype, save_extra_mains)
     if mtype == nil then
 
 function Place:write_place(k, v, mtype, save_extra_mains)
     if mtype == nil then


@@ -399,7 +371,7 @@ function module.tag_group(data)
 end
 
 -- Process functions for all data types
 end
 
 -- Process functions for all data types

-function osm2pgsql.process_node(object)
+function module.process_node(object)

 
     local function geom_func(o)
         return o:as_point()
 
     local function geom_func(o)
         return o:as_point()


@@ -408,7 +380,7 @@ function osm2pgsql.process_node(object)
     module.process_tags(Place.new(object, geom_func))
 end
 
     module.process_tags(Place.new(object, geom_func))
 end
 

-function osm2pgsql.process_way(object)
+function module.process_way(object)

 
     local function geom_func(o)
         local geom = o:as_polygon()
 
     local function geom_func(o)
         local geom = o:as_polygon()


@@ -423,15 +395,7 @@ function osm2pgsql.process_way(object)
     module.process_tags(Place.new(object, geom_func))
 end
 
     module.process_tags(Place.new(object, geom_func))
 end
 

-function module.relation_as_multipolygon(o)
-    return o:as_multipolygon()
-end
-
-function module.relation_as_multiline(o)
-    return o:as_multilinestring():line_merge()
-end
-
-function osm2pgsql.process_relation(object)
+function module.process_relation(object)

     local geom_func = module.RELATION_TYPES[object.tags.type]
 
     if geom_func ~= nil then
     local geom_func = module.RELATION_TYPES[object.tags.type]
 
     if geom_func ~= nil then


@@ -439,8 +403,13 @@ function osm2pgsql.process_relation(object)
     end
 end
 
     end
 end
 

+-- The process functions are used by default by osm2pgsql.
+osm2pgsql.process_node = module.process_node
+osm2pgsql.process_way = module.process_way
+osm2pgsql.process_relation = module.process_relation
+

 function module.process_tags(o)
 function module.process_tags(o)

-    o:clean{delete = module.PRE_DELETE, extra = module.PRE_EXTRAS}
+    o:clean{delete = PRE_DELETE, extra = PRE_EXTRAS}

 
     -- Exception for boundary/place double tagging
     if o.object.tags.boundary == 'administrative' then
 
     -- Exception for boundary/place double tagging
     if o.object.tags.boundary == 'administrative' then


@@ -450,50 +419,92 @@ function module.process_tags(o)
     end
 
     -- name keys
     end
 
     -- name keys

-    local fallback = o:grab_name_parts{groups=module.NAMES}
+    local fallback = o:grab_name_parts{groups=NAMES}

 
     -- address keys
 
     -- address keys

-    if o:grab_address_parts{groups=module.ADDRESS_TAGS} > 0 and fallback == nil then
+    if o:grab_address_parts{groups=ADDRESS_TAGS} > 0 and fallback == nil then

         fallback = {'place', 'house', 'always'}
     end
     if o.address.country ~= nil and #o.address.country ~= 2 then
         o.address['country'] = nil
     end
         fallback = {'place', 'house', 'always'}
     end
     if o.address.country ~= nil and #o.address.country ~= 2 then
         o.address['country'] = nil
     end

-    if fallback == nil and o.address.postcode ~= nil then
+    if POSTCODE_FALLBACK and fallback == nil and o.address.postcode ~= nil then

         fallback = {'place', 'postcode', 'always'}
     end
 
     if o.address.interpolation ~= nil then
         fallback = {'place', 'postcode', 'always'}
     end
 
     if o.address.interpolation ~= nil then

-        o:write_place('place', 'houses', 'always', module.SAVE_EXTRA_MAINS)
+        o:write_place('place', 'houses', 'always', SAVE_EXTRA_MAINS)

         return
     end
 
         return
     end
 

-    o:clean{delete = module.POST_DELETE, extra = module.POST_EXTRAS}
+    o:clean{delete = POST_DELETE, extra = POST_EXTRAS}

 
     -- collect main keys
     for k, v in pairs(o.object.tags) do
 
     -- collect main keys
     for k, v in pairs(o.object.tags) do

-        local ktype = module.MAIN_KEYS[k]
+        local ktype = MAIN_KEYS[k]

         if ktype == 'fallback' then
             if o.has_name then
                 fallback = {k, v, 'named'}
             end
         elseif ktype ~= nil then
         if ktype == 'fallback' then
             if o.has_name then
                 fallback = {k, v, 'named'}
             end
         elseif ktype ~= nil then

-            o:write_place(k, v,module.MAIN_KEYS[k], module.SAVE_EXTRA_MAINS)
+            o:write_place(k, v, MAIN_KEYS[k], SAVE_EXTRA_MAINS)

         end
     end
 
     if fallback ~= nil and o.num_entries == 0 then
         end
     end
 
     if fallback ~= nil and o.num_entries == 0 then

-        o:write_place(fallback[1], fallback[2], fallback[3], module.SAVE_EXTRA_MAINS)
+        o:write_place(fallback[1], fallback[2], fallback[3], SAVE_EXTRA_MAINS)

     end
 end
 
     end
 end
 

------- defaults --------------
+--------- Convenience functions for simple style configuration -----------------

 
 

-module.RELATION_TYPES = {
-    multipolygon = module.relation_as_multipolygon,
-    boundary = module.relation_as_multipolygon,
-    waterway = module.relation_as_multiline
-}

 
 

+function module.set_prefilters(data)
+    PRE_DELETE = module.tag_match{keys = data.delete_keys, tags = data.delete_tags}
+    PRE_EXTRAS = module.tag_match{keys = data.extra_keys,
+                                  tags = data.extra_tags}
+end
+
+function module.set_main_tags(data)
+    MAIN_KEYS = data
+end
+
+function module.set_name_tags(data)
+    NAMES = module.tag_group(data)
+end
+
+function module.set_address_tags(data)
+    if data.postcode_fallback ~= nil then
+        POSTCODE_FALLBACK = data.postcode_fallback
+        data.postcode_fallback = nil
+    end
+
+    ADDRESS_TAGS = module.tag_group(data)
+end
+
+function module.set_unused_handling(data)
+    if data.extra_keys == nil and data.extra_tags == nil then
+        POST_DELETE = module.tag_match{keys = data.delete_keys, tags = data.delete_tags}
+        POST_EXTRAS = nil
+        SAVE_EXTRA_MAINS = true
+    elseif data.delete_keys == nil and data.delete_tags == nil then
+        POST_DELETE = nil
+        POST_EXTRAS = module.tag_match{keys = data.extra_keys, tags = data.extra_tags}
+        SAVE_EXTRA_MAINS = false
+    else
+        error("unused handler can have only 'extra_keys' or 'delete_keys' set.")
+    end
+end
+
+function set_relation_types(data)
+    module.RELATION_TYPES = {}
+    for k, v in data do
+        if v == 'multipolygon' then
+            module.RELATION_TYPES[k] = module.relation_as_multipolygon
+        elseif v == 'multiline' then
+            module.RELATION_TYPES[k] = module.relation_as_multiline
+        end
+    end
+end

 
 return module
 
 return module