Categorygithub.com/whosonfirst/go-whosonfirst-spatial-hierarchy
modulepackage
0.7.0
Repository: https://github.com/whosonfirst/go-whosonfirst-spatial-hierarchy.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
20
Dependents
5
Files
397 SLOC

# README

go-whosonfirst-spatial-hierarchy

Opionated Who's On First (WOF) hierarchy for go-whosonfirst-spatial packages.

Documentation

Go Reference

Documentation is incomplete.

Example

import (
	_ "github.com/whosonfirst/go-whosonfirst-spatial-sqlite"
)

import (
	"github.com/whosonfirst/go-whosonfirst-spatial-hierarchy"
	hierarchy_filter "github.com/whosonfirst/go-whosonfirst-spatial-hierarchy/filter"		
	"github.com/whosonfirst/go-whosonfirst-spatial/database"
	spatial_filter "github.com/whosonfirst/go-whosonfirst-spatial/filter"
)

body := []byte(`{"type":"Feature" ...}`)

spatial_db, _ := database.NewSpatialDatabase(ctx, "sqlite://?dsn=/usr/local/data/whosonfirst.db")

resolver_opts := &hierarchy.PointInPolygonHierarchyResolverOptions{
	Database: spatial_db,
}

resolver, _ := hierarchy.NewPointInPolygonHierarchyResolver(ctx, resolver_opts)

inputs := &spatial_filter.SPRInputs{}

results_cb := hierarchy_filter.FirstButForgivingSPRResultsFunc
update_cb := hierarchy.DefaultPointInPolygonHierarchyResolverUpdateCallback()
		
new_body, _ := resolver.PointInPolygonAndUpdate(ctx, inputs, results_cb, update_cb, body)

See also

# Packages

No description provided by the author
No description provided by the author
No description provided by the author

# Functions

DefaultPointInPolygonHierarchyResolverUpdateCallback returns a `PointInPolygonHierarchyResolverUpdateCallback` function that will return a dictionary containing the following properties: wof:parent_id, wof:country, wof:hierarchy.
NewPointInPolygonHierarchyResolver returns a `PointInPolygonHierarchyResolver` instance for 'spatial_db' and 'ms_client'.

# Structs

PointInPolygonHierarchyResolver provides methods for constructing a hierarchy of ancestors for a given point, following rules established by the Who's On First project.
No description provided by the author

# Type aliases

PointInPolygonHierarchyResolverUpdateCallback is a function definition for a custom callback to convert 'spr' in to a dictionary of properties containining hierarchy information.