Ticket #645 (closed Task: fixed)
Revise Geomaps API wording
Reported by: | jri | Owned by: | jri |
---|---|---|---|
Priority: | Major | Milestone: | Release 4.3 |
Component: | DeepaMehta Standard Distribution | Version: | 4.2 |
Keywords: | Cc: | dgf, Malte | |
Complexity: | 3 | Area: | Application Framework / API |
Module: | deepamehta-geomaps |
Description
The methods and parameters of the Geomaps service should consistently reflect this nomenclature:
Geo Coordinate -- a lon/lat value. Represented as topic of type "Geo Coordinate".
Geo Topic -- a topic that is facetted with a Geo Coordinate, e.g. an Address.
Domain Topic -- The application-specific topic that is virtually placed on a Geomap, e.g. a Person.
Geomap -- A topicmap with an underlying geo cooordinate system. A geomap holds a collection of Geo Coordinates. To the user it looks as it would hold Domain Topics.
Change History
comment:2 Changed 11 years ago by Jörg Richter
Revise Geomaps API wording (#645).
The Geomap model class is now an iterable over its Geo Coordinates.
BREAKING CHANGES in Geomaps API:
Renamed:
getGeoTopic(long topicId) -> getDomainTopic(long geoCoordId)
addTopicToGeomap(long geomapId, long topicId) -> addCoordinateToGeomap(long geomapId, long geoCoordId)
Dropped:
getGeomapTopics(long geomapId)
RESTClient:
dm4c.restc.get_geotopic(topic_id) -> ..get_domain_topic(geo_coord_id)
dm4c.restc.add_topic_to_geomap(geomap_id, topic_id) -> ..add_coordinate_to_geomap(geomap_id, geo_coord_id)
See #645.