Area of Interest
Identifier:
net.refractions.udig.ui.aoi
Since:
1.3.0
Description:
Define a new Area of Interest to be used application wide as a limit. The use of the current AOI is context specific examples include as a target for Zoom To Extent or as a filter when displaying features in a TableView.
Use of the AOI is optional and placed under use control; the default value is considered to be All resulting in no AOI being defined.
Configuration Markup:
<!ELEMENT extension (aoi*)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED
>
- id - identifier of Area of Interest contribution used in log messages
- name - Human readible name of Area of Interest Contribution may be used in displayed error messages
<!ELEMENT aoi EMPTY>
<!ATTLIST aoi
id CDATA #REQUIRED
name CDATA #REQUIRED
class CDATA #REQUIRED
page CDATA #IMPLIED
>
Area of Interest used as an optional limit for search, feature display and zoom to extent.
- id - machine readible identifier suitable as a reference for logging or persistence.
- name - Area of Interest name displayed to a user in for example the AOIView.
- class - Implementation of IAOIStrategy used to supply a ReferencedEnvelope to any operations that require it.
- page - Optional Page to be displayed in the AOI View (or as a pop up) if the user wishes to configure the details of the current Area of Interest.
We make use of IPageBookViewPage although the abstract class Page is a recommended starting place.
Examples:
We have a couple good examples if you would like to review some sample code before getting started: ScreenAOIStrategy, MapCrsAOIStrategy and AOIStrategyAll.
To use the current AOI you can make use of the workbench AOIService as follows:
IAOIService aoiService = PlatformGIS.getAOIService();
ReferencedEnvelope extent = aoiService.getExtent();
API Information:
Implementors are asked to porvide an implementation of IAOIStrategy; as an option they may also provide a Page for futher confiuration options.
Supplied Implementation:
Please note the use of a Page is optional; if a page is not provided the user will simply be able to choose from a list; and the Page area will be filled in with a short description.
uDig - User Friendly Desktop Internet GIS client