Geographic annotation for Plone
Project description
Introduction
============
.. role:: class(raw)
:format: html
.. role:: func(raw)
:format: html
.. role:: mod(raw)
:format: html
:mod:`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.
.. image:: https://secure.travis-ci.org/collective/collective.geo.geographer.png
:target: http://travis-ci.org/collective/collective.geo.geographer
Found a bug? Please, use the `issue tracker`_.
.. contents:: Table of contents
Requirements
============
* `geopy`_
* `Plone`_ >= 4
How it work
===========
Any object that implements
:class:`IAttributeAnnotatable <zope.annotation.interfaces.IAttributeAnnotatable>`
and
:class:`IGeoreferenceable <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 :class:`IGeoreferenced <collective.geo.geographer.interfaces.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
:func:`setGeoInterface <IWritableGeoreference.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 :func:`removeGeoInterface <IWritableGeoreference.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
:class:`IGeoreferenceable <collective.geo.geographer.interfaces.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
:class:`IObjectGeoreferencedEvent <collective.geo.geographer.event.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 - :class:`geoview <collective.geo.geographer.interfaces.IGeoView>`
- 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
.. _zgeo.geographer: http://pypi.python.org/pypi/zgeo.geographer
.. _geopy: http://pypi.python.org/pypi/geopy
.. _Plone: http://plone.org
.. _issue tracker: https://github.com/collective/collective.geo.bundle/issues
Contributors
============
* Sean Gillies
* Giorgio Borelli
* Christian Ledermann
* Mirco Angelini
Changelog
=========
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
============
.. role:: class(raw)
:format: html
.. role:: func(raw)
:format: html
.. role:: mod(raw)
:format: html
:mod:`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.
.. image:: https://secure.travis-ci.org/collective/collective.geo.geographer.png
:target: http://travis-ci.org/collective/collective.geo.geographer
Found a bug? Please, use the `issue tracker`_.
.. contents:: Table of contents
Requirements
============
* `geopy`_
* `Plone`_ >= 4
How it work
===========
Any object that implements
:class:`IAttributeAnnotatable <zope.annotation.interfaces.IAttributeAnnotatable>`
and
:class:`IGeoreferenceable <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 :class:`IGeoreferenced <collective.geo.geographer.interfaces.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
:func:`setGeoInterface <IWritableGeoreference.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 :func:`removeGeoInterface <IWritableGeoreference.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
:class:`IGeoreferenceable <collective.geo.geographer.interfaces.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
:class:`IObjectGeoreferencedEvent <collective.geo.geographer.event.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 - :class:`geoview <collective.geo.geographer.interfaces.IGeoView>`
- 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
.. _zgeo.geographer: http://pypi.python.org/pypi/zgeo.geographer
.. _geopy: http://pypi.python.org/pypi/geopy
.. _Plone: http://plone.org
.. _issue tracker: https://github.com/collective/collective.geo.bundle/issues
Contributors
============
* Sean Gillies
* Giorgio Borelli
* Christian Ledermann
* Mirco Angelini
Changelog
=========
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
collective.geo.geographer-1.5.zip
(36.0 kB
view hashes)
Close
Hashes for collective.geo.geographer-1.5.zip
Algorithm | Hash digest | |
---|---|---|
SHA256 | 028d5b508689e08d02f24c54b45d921cfd890e4d1e689276cdf0e3d717736cbf |
|
MD5 | 14f817272892927a1e2672d7c18e02b6 |
|
BLAKE2b-256 | 2e09fe28dc640a4f0fa0ae528d068391987f54fecf72df52153e98d35a5e26be |