Skip to main content
Help us improve Python packaging – donate today!

Geographic annotation for Plone

Project Description

Introduction

collective.geo.geographer provides geo annotation for Plone.

This package is based on Sean Gillies’s idea (zgeo.geographer) and integrates its functionalities in collective.geo project.

https://secure.travis-ci.org/collective/collective.geo.geographer.png

Found a bug? Please, use the issue tracker.

How it work

Any object that implements IAttributeAnnotatable and IGeoreferenceable can be adapted and geo-referenced.

The former marker is standard for Zope content objects, and the latter can be easily configured via ZCML.

Let’s test with an example placemark, which provides both of the marker interfaces mentioned above.

>>> from zope.interface import implements
>>> from zope.annotation.interfaces import IAttributeAnnotatable
>>> from collective.geo.geographer.interfaces import IGeoreferenceable

>>> class Placemark(object):
...     implements(IGeoreferenceable, IAttributeAnnotatable)

>>> placemark = Placemark()

Adapt it to IGeoreferenced

>>> from collective.geo.geographer.interfaces import IGeoreferenced
>>> geo = IGeoreferenced(placemark)

Its properties should all be None

>>> geo.type is None
True
>>> geo.coordinates is None
True
>>> geo.crs is None
True

Now set the location geometry to type Point and coordinates 105.08 degrees West, 40.59 degrees North using setGeoInterface:

>>> geo.setGeoInterface('Point', (-105.08, 40.59))

A georeferenced object has type and coordinates attributes which should give us back what we put in.

>>> geo.type
'Point'
>>> tuple(['%.2f' % x for x in geo.coordinates])
('-105.08', '40.59')
>>> geo.crs is None
True

An event should have been sent

>>> from zope.component.eventtesting import getEvents
>>> from collective.geo.geographer.event import IObjectGeoreferencedEvent
>>> events = getEvents(IObjectGeoreferencedEvent)
>>> events[-1].object is placemark
True

To remove the coordinate from a georeferenced object, we can use removeGeoInterface method:

>>> geo.removeGeoInterface()
>>> geo.type is None
True
>>> geo.coordinates is None
True
>>> geo.crs is None
True

Plone integration

Add geo-referenced content

>>> from plone.app.testing import setRoles
>>> from plone.app.testing import TEST_USER_ID
>>> portal = layer['portal']
>>> setRoles(portal, TEST_USER_ID, ['Manager'])

>>> oid = portal.invokeFactory('Document', 'doc')
>>> doc = portal[oid]

If content type doesn’t implements IGeoreferenceable interfaces we need to provide it

>>> from zope.interface import alsoProvides
>>> alsoProvides(doc, IGeoreferenceable)

now we can set the coordinates

>>> from collective.geo.geographer.interfaces import IWriteGeoreferenced
>>> geo = IWriteGeoreferenced(doc)
>>> geo.setGeoInterface('Point', (-100, 40))

and reindex the document.

>>> doc.reindexObject(idxs=['zgeo_geometry'])

We can create a subscriber for IObjectGeoreferencedEvent to do that automatically.

Check the catalog results

>>> from Products.CMFCore.utils import getToolByName
>>> catalog = getToolByName(portal, 'portal_catalog')
>>> brain = [b for b in catalog({'getId': 'doc'})][0]
>>> brain.zgeo_geometry['type']
'Point'
>>> brain.zgeo_geometry['coordinates']
(-100, 40)

A simple view - geoview - notify us if a context is geo referenceable:

>>> view = doc.restrictedTraverse('@@geoview')
>>> view.isGeoreferenceable()
True

and return its coordinates:

>>> view.getCoordinates()
('Point', (-100, 40))

When we remove the coordinates, corresponding index will return None

>>> geo.removeGeoInterface()
>>> doc.reindexObject(idxs=['zgeo_geometry'])
>>> brain = [b for b in catalog({'getId': 'doc'})][0]
>>> brain.zgeo_geometry is None
True

Release history Release notifications

History Node

2.1

History Node

2.0

History Node

2.0b1

History Node

1.7

This version
History Node

1.6

History Node

1.5

History Node

1.4

History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

History Node

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
collective.geo.geographer-1.6.zip (40.3 kB) Copy SHA256 hash SHA256 Source None Jan 28, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page