Package org.apache.sis.metadata.iso.citation

Class DefaultAddress

java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.citation.DefaultAddress
All Implemented Interfaces:
Serializable, Emptiable, LenientComparable, IdentifiedObject, org.opengis.metadata.citation.Address
public class DefaultAddress extends ISOMetadata implements org.opengis.metadata.citation.Address
Location of the responsible individual or organization.

Limitations

  • Instances of this class are not synchronized for multi-threading. Synchronization, if needed, is caller's responsibility.
  • 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 XML instead.
Since:
0.3
Version:
1.0
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      Serial number for inter-operability with different versions.
      See Also:

    • administrativeArea

      private org.opengis.util.InternationalString administrativeArea
      State, province of the location.

    • city

      private org.opengis.util.InternationalString city
      The city of the location

    • country

      private org.opengis.util.InternationalString country
      Country of the physical address.

    • postalCode

      private String postalCode
      ZIP or other postal code.

    • deliveryPoints

      private Collection<String> deliveryPoints
      Address line for the location (as described in ISO 11180, Annex A).

    • electronicMailAddresses

      private Collection<String> electronicMailAddresses
      Address of the electronic mailbox of the responsible organization or individual.

  • Constructor Details

    • DefaultAddress

      public DefaultAddress()
      Constructs an initially empty address.

    • DefaultAddress

      public DefaultAddress(org.opengis.metadata.citation.Address object)
      Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, because the other metadata contained in the given object are not recursively copied.
      Parameters:
      object - the metadata to copy values from, or null if none.
      See Also:

  • Method Details

    • castOrCopy

      public static DefaultAddress castOrCopy(org.opengis.metadata.citation.Address object)
      Returns a SIS metadata implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:
      • If the given object is null, then this method returns null.
      • Otherwise if the given object is already an instance of DefaultAddress, then it is returned unchanged.
      • Otherwise a new DefaultAddress instance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other metadata contained in the given object are not recursively copied.
      Parameters:
      object - the object to get as a SIS implementation, or null if none.
      Returns:
      a SIS implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

    • getAdministrativeArea

      public org.opengis.util.InternationalString getAdministrativeArea()
      Return the state, province of the location.
      Specified by:
      getAdministrativeArea in interface org.opengis.metadata.citation.Address
      Returns:
      state, province of the location, or null.

    • setAdministrativeArea

      public void setAdministrativeArea(org.opengis.util.InternationalString newValue)
      Sets the state, province of the location.
      Parameters:
      newValue - the new administrative area.

    • getCity

      public org.opengis.util.InternationalString getCity()
      Returns the city of the location.
      Specified by:
      getCity in interface org.opengis.metadata.citation.Address
      Returns:
      the city of the location, or null.

    • setCity

      public void setCity(org.opengis.util.InternationalString newValue)
      Sets the city of the location.
      Parameters:
      newValue - the new city, or null if none.

    • getCountry

      public org.opengis.util.InternationalString getCountry()
      Returns the country of the physical address.
      Specified by:
      getCountry in interface org.opengis.metadata.citation.Address
      Returns:
      country of the physical address, or null.

    • setCountry

      public void setCountry(org.opengis.util.InternationalString newValue)
      Sets the country of the physical address.
      Parameters:
      newValue - the new country, or null if none.

    • getDeliveryPoints

      public Collection<String> getDeliveryPoints()
      Returns the address line for the location (as described in ISO 11180, Annex A).
      Upcoming API change — internationalization
      The return type may be changed from Collection<String> to Collection<? extends InternationalString> in GeoAPI 4.0.
      Specified by:
      getDeliveryPoints in interface org.opengis.metadata.citation.Address
      Returns:
      address line for the location.

    • setDeliveryPoints

      public void setDeliveryPoints(Collection<? extends String> newValues)
      Sets the address line for the location (as described in ISO 11180, Annex A).
      Upcoming API change — internationalization
      The argument type may be changed from Collection<String> to Collection<? extends InternationalString> in GeoAPI 4.0.
      Parameters:
      newValues - the new delivery points, or null if none.

    • getElectronicMailAddresses

      public Collection<String> getElectronicMailAddresses()
      Returns the address of the electronic mailbox of the responsible organization or individual.
      Specified by:
      getElectronicMailAddresses in interface org.opengis.metadata.citation.Address
      Returns:
      address of the electronic mailbox of the responsible organization or individual.

    • setElectronicMailAddresses

      public void setElectronicMailAddresses(Collection<? extends String> newValues)
      Sets the address of the electronic mailbox of the responsible organization or individual.
      Parameters:
      newValues - the new electronic mail addresses, or null if none.

    • getPostalCode

      public String getPostalCode()
      Returns ZIP or other postal code.
      Specified by:
      getPostalCode in interface org.opengis.metadata.citation.Address
      Returns:
      ZIP or other postal code, or null.

    • setPostalCode

      public void setPostalCode(String newValue)
      Sets ZIP or other postal code.
      Parameters:
      newValue - the new postal code, or null if none.