| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You under the Apache License, Version 2.0 |
| * (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.apache.sis.metadata.iso.citation; |
| |
| import java.util.Collection; |
| import javax.xml.bind.annotation.XmlType; |
| import javax.xml.bind.annotation.XmlElement; |
| import javax.xml.bind.annotation.XmlRootElement; |
| import org.opengis.util.InternationalString; |
| import org.opengis.metadata.citation.Address; |
| import org.apache.sis.metadata.iso.ISOMetadata; |
| |
| |
| /** |
| * Location of the responsible individual or organization. |
| * |
| * <p><b>Limitations:</b></p> |
| * <ul> |
| * <li>Instances of this class are not synchronized for multi-threading. |
| * Synchronization, if needed, is caller's responsibility.</li> |
| * <li>Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases. |
| * Serialization support is appropriate for short term storage or RMI between applications running the |
| * same version of Apache SIS. For long term storage, use {@link org.apache.sis.xml.XML} instead.</li> |
| * </ul> |
| * |
| * @author Martin Desruisseaux (IRD, Geomatys) |
| * @author Touraïvane (IRD) |
| * @author Cédric Briançon (Geomatys) |
| * @version 1.0 |
| * @since 0.3 |
| * @module |
| */ |
| @XmlType(name = "CI_Address_Type", propOrder = { |
| "deliveryPoints", |
| "city", |
| "administrativeArea", |
| "postalCode", |
| "country", |
| "electronicMailAddresses" |
| }) |
| @XmlRootElement(name = "CI_Address") |
| public class DefaultAddress extends ISOMetadata implements Address { |
| /** |
| * Serial number for inter-operability with different versions. |
| */ |
| private static final long serialVersionUID = -1709738216789373888L; |
| |
| /** |
| * State, province of the location. |
| */ |
| private InternationalString administrativeArea; |
| |
| /** |
| * The city of the location |
| */ |
| private InternationalString city; |
| |
| /** |
| * Country of the physical address. |
| */ |
| private InternationalString country; |
| |
| /** |
| * ZIP or other postal code. |
| */ |
| private String postalCode; |
| |
| /** |
| * Address line for the location (as described in ISO 11180, Annex A). |
| */ |
| private Collection<InternationalString> deliveryPoints; |
| |
| /** |
| * Address of the electronic mailbox of the responsible organization or individual. |
| */ |
| private Collection<String> electronicMailAddresses; |
| |
| /** |
| * Constructs an initially empty address. |
| */ |
| public DefaultAddress() { |
| } |
| |
| /** |
| * Constructs a new instance initialized with the values from the specified metadata object. |
| * This is a <cite>shallow</cite> copy constructor, since the other metadata contained in the |
| * given object are not recursively copied. |
| * |
| * @param object the metadata to copy values from, or {@code null} if none. |
| * |
| * @see #castOrCopy(Address) |
| */ |
| public DefaultAddress(final Address object) { |
| super(object); |
| if (object != null) { |
| deliveryPoints = copyCollection(object.getDeliveryPoints(), InternationalString.class); |
| city = object.getCity(); |
| administrativeArea = object.getAdministrativeArea(); |
| postalCode = object.getPostalCode(); |
| country = object.getCountry(); |
| electronicMailAddresses = copyCollection(object.getElectronicMailAddresses(), String.class); |
| } |
| } |
| |
| /** |
| * Returns a SIS metadata implementation with the values of the given arbitrary implementation. |
| * This method performs the first applicable action in the following choices: |
| * |
| * <ul> |
| * <li>If the given object is {@code null}, then this method returns {@code null}.</li> |
| * <li>Otherwise if the given object is already an instance of |
| * {@code DefaultAddress}, then it is returned unchanged.</li> |
| * <li>Otherwise a new {@code DefaultAddress} instance is created using the |
| * {@linkplain #DefaultAddress(Address) copy constructor} |
| * and returned. Note that this is a <cite>shallow</cite> copy operation, since the other |
| * metadata contained in the given object are not recursively copied.</li> |
| * </ul> |
| * |
| * @param object the object to get as a SIS implementation, or {@code null} if none. |
| * @return a SIS implementation containing the values of the given object (may be the |
| * given object itself), or {@code null} if the argument was null. |
| */ |
| public static DefaultAddress castOrCopy(final Address object) { |
| if (object == null || object instanceof DefaultAddress) { |
| return (DefaultAddress) object; |
| } |
| return new DefaultAddress(object); |
| } |
| |
| /** |
| * Return the state, province of the location. |
| * |
| * @return state, province of the location, or {@code null}. |
| */ |
| @Override |
| @XmlElement(name = "administrativeArea") |
| public InternationalString getAdministrativeArea() { |
| return administrativeArea; |
| } |
| |
| /** |
| * Sets the state, province of the location. |
| * |
| * @param newValue the new administrative area. |
| */ |
| public void setAdministrativeArea(final InternationalString newValue) { |
| checkWritePermission(administrativeArea); |
| administrativeArea = newValue; |
| } |
| |
| /** |
| * Returns the city of the location. |
| * |
| * @return the city of the location, or {@code null}. |
| */ |
| @Override |
| @XmlElement(name = "city") |
| public InternationalString getCity() { |
| return city; |
| } |
| |
| /** |
| * Sets the city of the location. |
| * |
| * @param newValue the new city, or {@code null} if none. |
| */ |
| public void setCity(final InternationalString newValue) { |
| checkWritePermission(city); |
| city = newValue; |
| } |
| |
| /** |
| * Returns the country of the physical address. |
| * |
| * @return country of the physical address, or {@code null}. |
| */ |
| @Override |
| @XmlElement(name = "country") |
| public InternationalString getCountry() { |
| return country; |
| } |
| |
| /** |
| * Sets the country of the physical address. |
| * |
| * @param newValue the new country, or {@code null} if none. |
| */ |
| public void setCountry(final InternationalString newValue) { |
| checkWritePermission(country); |
| country = newValue; |
| } |
| |
| /** |
| * Returns the address line for the location (as described in ISO 11180, Annex A). |
| * |
| * @return address line for the location. |
| */ |
| @Override |
| @XmlElement(name = "deliveryPoint") |
| public Collection<InternationalString> getDeliveryPoints() { |
| return deliveryPoints = nonNullCollection(deliveryPoints, InternationalString.class); |
| } |
| |
| /** |
| * Sets the address line for the location (as described in ISO 11180, Annex A). |
| * |
| * @param newValues the new delivery points, or {@code null} if none. |
| */ |
| public void setDeliveryPoints(final Collection<? extends InternationalString> newValues) { |
| deliveryPoints = writeCollection(newValues, deliveryPoints, InternationalString.class); |
| } |
| |
| /** |
| * Returns the address of the electronic mailbox of the responsible organization or individual. |
| * |
| * @return address of the electronic mailbox of the responsible organization or individual. |
| */ |
| @Override |
| @XmlElement(name = "electronicMailAddress") |
| public Collection<String> getElectronicMailAddresses() { |
| return electronicMailAddresses = nonNullCollection(electronicMailAddresses, String.class); |
| } |
| |
| /** |
| * Sets the address of the electronic mailbox of the responsible organization or individual. |
| * |
| * @param newValues the new electronic mail addresses, or {@code null} if none. |
| */ |
| public void setElectronicMailAddresses(final Collection<? extends String> newValues) { |
| electronicMailAddresses = writeCollection(newValues, electronicMailAddresses, String.class); |
| } |
| |
| /** |
| * Returns ZIP or other postal code. |
| * |
| * @return ZIP or other postal code, or {@code null}. |
| */ |
| @Override |
| @XmlElement(name = "postalCode") |
| public String getPostalCode() { |
| return postalCode; |
| } |
| |
| /** |
| * Sets ZIP or other postal code. |
| * |
| * @param newValue the new postal code, or {@code null} if none. |
| */ |
| public void setPostalCode(final String newValue) { |
| checkWritePermission(postalCode); |
| postalCode = newValue; |
| } |
| } |