001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2004-2012 Open Geospatial Consortium, Inc.
006 * All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007 *
008 * Permission to use, copy, and modify this software and its documentation, with
009 * or without modification, for any purpose and without fee or royalty is hereby
010 * granted, provided that you include the following on ALL copies of the software
011 * and documentation or portions thereof, including modifications, that you make:
012 *
013 * 1. The full text of this NOTICE in a location viewable to users of the
014 * redistributed or derivative work.
015 * 2. Notice of any changes or modifications to the OGC files, including the
016 * date changes were made.
017 *
018 * THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019 * NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020 * TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021 * THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022 * PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023 *
024 * COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025 * CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026 *
027 * The name and trademarks of copyright holders may NOT be used in advertising or
028 * publicity pertaining to the software without specific, written prior permission.
029 * Title to copyright in this software and any associated documentation will at all
030 * times remain with copyright holders.
031 */
032 package org.opengis.metadata.citation;
033
034 import java.util.Collection;
035 import org.opengis.util.InternationalString;
036 import org.opengis.annotation.UML;
037
038 import static org.opengis.annotation.Obligation.*;
039 import static org.opengis.annotation.Specification.*;
040
041
042 /**
043 * Location of the responsible individual or organization.
044 *
045 * @author Martin Desruisseaux (IRD)
046 * @version 3.0
047 * @since 1.0
048 */
049 @UML(identifier="CI_Address", specification=ISO_19115)
050 public interface Address {
051 /**
052 * Address line for the location (as described in ISO 11180, Annex A).
053 * Returns an empty collection if none.
054 *
055 * @return Address line for the location.
056 */
057 @UML(identifier="deliveryPoint", obligation=OPTIONAL, specification=ISO_19115)
058 Collection<String> getDeliveryPoints();
059
060 /**
061 * The city of the location.
062 * Returns {@code null} if unspecified.
063 *
064 * @return The city of the location, or {@code null}.
065 */
066 @UML(identifier="city", obligation=OPTIONAL, specification=ISO_19115)
067 InternationalString getCity();
068
069 /**
070 * State, province of the location.
071 * Returns {@code null} if unspecified.
072 *
073 * @return State, province of the location, or {@code null}.
074 */
075 @UML(identifier="administrativeArea", obligation=OPTIONAL, specification=ISO_19115)
076 InternationalString getAdministrativeArea();
077
078 /**
079 * ZIP or other postal code.
080 * Returns {@code null} if unspecified.
081 *
082 * @return ZIP or other postal code, or {@code null}.
083 */
084 @UML(identifier="postalCode", obligation=OPTIONAL, specification=ISO_19115)
085 String getPostalCode();
086
087 /**
088 * Country of the physical address.
089 * Returns {@code null} if unspecified.
090 *
091 * @return Country of the physical address, or {@code null}.
092 */
093 @UML(identifier="country", obligation=OPTIONAL, specification=ISO_19115)
094 InternationalString getCountry();
095
096 /**
097 * Address of the electronic mailbox of the responsible organization or individual.
098 * Returns an empty collection if none.
099 *
100 * @return Address of the electronic mailbox of the responsible organization or individual.
101 */
102 @UML(identifier="electronicMailAddress", obligation=OPTIONAL, specification=ISO_19115)
103 Collection<String> getElectronicMailAddresses();
104 }