Package biz.janux.geography

The biz.janux.geography package aims to support the handling and storing of Postal Addresses in the context of managing contact methods for Person and Organizations; in the future, it may be extended to provide functionality for searching by geographic coordinates; the functionality of this package is exposed via the GeographyService Service Facade.

See:
          Description

Interface Summary
City  
CityDao Deprecated. use CityDaoGeneric
CityDaoGeneric<T extends City> Data Access Class used to access and manage City entities
Country Interface representing a Country; contains convenience classes for storing ISO Code and International Phone code; all State/Provinces and Cities in the system contain references to their containing Country
CountryDao Deprecated. use CountryDaoGeneric
CountryDaoGeneric<T extends Country> Performs commonly requested operations on Country objects
GeographyService Used to create, save, retrieve, update and delete Geographical entities from persistent storage The biz.janux.geography package strives to treat City/State/Province/Country as entities, rather than as mere strings within an address (though it also supports the string-based approach); by treating geographical subdivisions as entities, it becomes possible, for example, to store information about these geographical subdivisions, or to easily derive geography-based statistics.
PostalAddress Represents a Postal Address; this class aims to be independent of how an address may be represented in an individual country; StateProvince, Country and City are represented as objects rather than Strings; refer to the package documentation for biz.janux.geography for more information on the relationship between City, StateProvince and Country
PostalAddressDao Deprecated. use PostalAddressDaoGeneric
PostalAddressDaoGeneric<T extends PostalAddress> Data Access Class used to access and manage PostalAddress entities
StateProvince Interface representing a State or Province; States or Provinces are defined relative to the Country that contains them, and hence are required to contain a reference to this Country
StateProvinceDao Deprecated. use StateProvinceDaoGeneric
StateProvinceDaoGeneric<T extends StateProvince> Dao used to retrieve and save StateProvince Entities
 

Package biz.janux.geography Description

The biz.janux.geography package aims to support the handling and storing of Postal Addresses in the context of managing contact methods for Person and Organizations; in the future, it may be extended to provide functionality for searching by geographic coordinates; the functionality of this package is exposed via the GeographyService Service Facade.

The geography models a PostalAddress object, and treats the City, State or Province, and Country associated to a PostalAddress as entities having an independent lifecycle; as illustrated below:

Nevertheless, the PostalAddress interface also handles the case where the address must be parsed from unstructured or loosely structured text. In such situation, it may not be possible to reliably associate this address to City, StateProvince or Country entities, and these fields must be stored as strings. To this end, the PostalAddress interface provides methods such as setCountryAsString(String) that can be used to store the various components of an address as Strings. This is treated in more detail in the documentation of the GeographyService.

As a result, the relationships between Postal Address and the City/StateProvince/Countries entities are 0..* --> 0..1 to allow for situations where we may not be able to represent this data as entity, but must instead store them as strings.



Copyright © 2005-2013 Janux. All Rights Reserved.