collective.geo.geographer

Geographic annotation for Plone

Project Description

collective.geo.geographer

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.

Installation

This addon can be installed has any other addons, please follow official documentation.

How it work

Any object that implements IAttributeAnnotatable and collective.geo.geographer.interfaces.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

Check whether geo referenceable object has coordinates or not

>>> geo.hasCoordinates()
False

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

now hasCoordinates method returns True

>>> geo.hasCoordinates()
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 implement 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
Missing.Value

Contributors

  • Sean Gillies
  • Giorgio Borelli
  • Christian Ledermann
  • Mirco Angelini

Changelog

2.0 (2013-10-29)

  • Changed package layout [gborelli]
  • remove style key from zgeo_geometry metadata [gborelli]
  • move IGeoCoder utility to c.geo.mapwidget [gborelli]
  • remove IGeoCoder adapter [gborelli]

1.7 (2013-04-11)

  • Fixed permission on GeoreferencingAnnotator. See #3 [gborelli]
  • Moved showCoordinatesTab to c.geo.contentlocations [gborelli]
  • Added hasCoordinates method to GeoreferencingAnnotator to check whether an object has been georeferenced or not [gborelli]
  • Added a method in order to hidden Coordinates tab for dexterity content types [valentinaB]
  • Changed Version of Geopy (moved from 0.94.2 to 0.95) to support Google api v3 in geocoder [cippino]

1.6 (2013-01-28)

  • Fixed MANIFEST.in [gborelli]

1.5 (2013-01-28)

  • Added Sphinx documentation [gborelli]
  • Added travis-ci configurations [gborelli]
  • Moved reindexDocSubscriber to collective.geo.contentlocations [gborelli]
  • Refactored test and removed dependency from old Topic content type [gborelli]

1.4 (2012-02-11)

  • changed tests using plone.app.testing [gborelli]
  • Added IGeoCoder utility [gborelli]
  • Marked as deprecated IGeoCoder adapter [gborelli]
  • Added removeGeoInterface to remove coordinates from an object [mircoangelini]

0.1.3 (2011-09-05)

  • plone 4.1 fixes [gborelli]
  • include Products.CMFCore to make plone 4.1 happy [nan010]
  • changed Browser import from Testing.testbrowser [gborelli]
  • added z3c.autoinclude entry point [gborelli]

0.1.2 (2010-12-28)

  • Moved IGeoView from c.geo.contentlocations

0.1.1 (2010-11-13)

  • moved geocoderview to portal root

0.1 (2010-10-31)

  • removed zgeo.geographer dependency
  • zgeo.plone.geographer code refactoring
  • moved from zgeo.plone.geographer

Self-Certification

[X] Internationalized

[X] Unit tests

[ ] End-user documentation

[ ] Internal documentation (documentation, interfaces, etc.)

[X] Existed and maintained for at least 6 months

[ ] Installs and uninstalls cleanly

[ ] Code structure follows best practice

Current Release
collective.geo.geographer 2.0

Released Oct 29, 2013 — tested with Plone 4.3, Plone 4.2, Plone 4.1, Plone 4

moved moved IGeoCoder utility to c.geo.mapwidget and changed package layout
More about this release…

Download file Get collective.geo.geographer for all platforms
collective.geo.geographer-2.0.zip
If you are using Plone 3.2 or higher, you probably want to install this product with buildout. See our tutorial on installing add-on products with buildout for more information.

All Releases

Version Released Description Compatibility Licenses Status
2.0b1 moved IGeoCoder utility to c.geo.mapwidget More about this release…
Plone 4.3
Plone 4.2
Plone 4.1
Plone 4
GPL beta
2.0 Oct 29, 2013 moved moved IGeoCoder utility to c.geo.mapwidget and changed package layout More about this release…
Plone 4.3
Plone 4.2
Plone 4.1
Plone 4
GPL final
1.7 Apr 11, 2013 google api v3 support More about this release…
Plone 4.2
Plone 4.1
Plone 4
GPL final
1.6 Jan 28, 2013 moved reindexDocSubscriber to collective.geo.contentlocations and removed dependency from old Topic content type More about this release…
Plone 4.2
GPL final
1.5 Jan 28, 2013 More about this release… GPL final
0.1.3 Sep 05, 2011 bug fixes and plone 4.1 compatibility More about this release…
Plone 4.1
Plone 4
GPL final
0.1.2 Dec 28, 2010 minor fixes More about this release…
Plone 4
GPL final
0.1.1 Nov 13, 2010 moved geocoderview to portal root More about this release…
Plone 4
GPL final
0.1 first release More about this release…
Plone 4
GPL beta
1.4 Feb 11, 2012 Added removeGeoInterface to remove coordinates and added IGeoCoder utility More about this release…
Plone 4.2
Plone 4.1
Plone 4
GPL final