Module org.opengis.geoapi

Package org.opengis.metadata.citation

Interface Address

@Classifier(DATATYPE)
@UML(identifier="CI_Address",
     specification=ISO_19115)
public interface Address

Location of the responsible individual or organization.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
default InternationalString	getAdministrativeArea()	State, province of the location.
default InternationalString	getCity()	The city of the location.
default InternationalString	getCountry()	Country of the physical address.
default Collection<String>	getDeliveryPoints()	Address lines for the location (as described in ISO 11180, Annex A).
default Collection<String>	getElectronicMailAddresses()	Address of the electronic mailbox of the responsible organization or individual.
default String	getPostalCode()	ZIP or other postal code.

Method Details

getDeliveryPoints

@UML(identifier="deliveryPoint",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<String> getDeliveryPoints()

Address lines for the location (as described in ISO 11180, Annex A). This method allows multiple values for describing a location on many lines, not for enumerating many locations.

Upcoming API change — internationalization
The return type will be changed from Collection<String> to Collection<? extends InternationalString> in GeoAPI 4.0.

Returns:

address lines for the location, or an empty collection if none.

TODO:

https://github.com/opengeospatial/geoapi/issues/34

getCity

@UML(identifier="city",
     obligation=OPTIONAL,
     specification=ISO_19115)
default InternationalString getCity()

The city of the location. Returns null if unspecified.

Returns:

the city of the location, or null.

getAdministrativeArea

@UML(identifier="administrativeArea",
     obligation=OPTIONAL,
     specification=ISO_19115)
default InternationalString getAdministrativeArea()

State, province of the location. Returns null if unspecified.

Returns:

state, province of the location, or null.

getPostalCode

@UML(identifier="postalCode",
     obligation=OPTIONAL,
     specification=ISO_19115)
default String getPostalCode()

ZIP or other postal code. Returns null if unspecified.

Returns:

ZIP or other postal code, or null.

getCountry

@UML(identifier="country",
     obligation=OPTIONAL,
     specification=ISO_19115)
default InternationalString getCountry()

Country of the physical address. Returns null if unspecified.

Returns:

country of the physical address, or null.

getElectronicMailAddresses

@UML(identifier="electronicMailAddress",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<String> getElectronicMailAddresses()

Address of the electronic mailbox of the responsible organization or individual. Returns an empty collection if none.

Returns:

address of the electronic mailbox of the responsible organization or individual.