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
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:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.sis.metadata.ModifiableMetadata
ModifiableMetadata.State
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate org.opengis.util.InternationalString
State, province of the location.private org.opengis.util.InternationalString
The city of the locationprivate org.opengis.util.InternationalString
Country of the physical address.private Collection<String>
Address line for the location (as described in ISO 11180, Annex A).private Collection<String>
Address of the electronic mailbox of the responsible organization or individual.private String
ZIP or other postal code.private static final long
Serial number for inter-operability with different versions.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty address.DefaultAddress
(org.opengis.metadata.citation.Address object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultAddress
castOrCopy
(org.opengis.metadata.citation.Address object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.org.opengis.util.InternationalString
Return the state, province of the location.org.opengis.util.InternationalString
getCity()
Returns the city of the location.org.opengis.util.InternationalString
Returns the country of the physical address.Returns the address line for the location (as described in ISO 11180, Annex A).Returns the address of the electronic mailbox of the responsible organization or individual.Returns ZIP or other postal code.void
setAdministrativeArea
(org.opengis.util.InternationalString newValue) Sets the state, province of the location.void
setCity
(org.opengis.util.InternationalString newValue) Sets the city of the location.void
setCountry
(org.opengis.util.InternationalString newValue) Sets the country of the physical address.void
setDeliveryPoints
(Collection<? extends String> newValues) Sets the address line for the location (as described in ISO 11180, Annex A).void
setElectronicMailAddresses
(Collection<? extends String> newValues) Sets the address of the electronic mailbox of the responsible organization or individual.void
setPostalCode
(String newValue) Sets ZIP or other postal code.Methods inherited from class org.apache.sis.metadata.iso.ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionTo
Methods inherited from class org.apache.sis.metadata.ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSet
Methods inherited from class org.apache.sis.metadata.AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
administrativeArea
private org.opengis.util.InternationalString administrativeAreaState, province of the location. -
city
private org.opengis.util.InternationalString cityThe city of the location -
country
private org.opengis.util.InternationalString countryCountry of the physical address. -
postalCode
ZIP or other postal code. -
deliveryPoints
Address line for the location (as described in ISO 11180, Annex A). -
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, ornull
if none.- See Also:
-
-
Method Details
-
castOrCopy
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 returnsnull
. - 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, ornull
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.
- If the given object is
-
getAdministrativeArea
public org.opengis.util.InternationalString getAdministrativeArea()Return the state, province of the location.- Specified by:
getAdministrativeArea
in interfaceorg.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 interfaceorg.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, ornull
if none.
-
getCountry
public org.opengis.util.InternationalString getCountry()Returns the country of the physical address.- Specified by:
getCountry
in interfaceorg.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, ornull
if none.
-
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 fromCollection<String>
toCollection<? extends InternationalString>
in GeoAPI 4.0.- Specified by:
getDeliveryPoints
in interfaceorg.opengis.metadata.citation.Address
- Returns:
- address line for the location.
-
setDeliveryPoints
Sets the address line for the location (as described in ISO 11180, Annex A).Upcoming API change — internationalization
The argument type may be changed fromCollection<String>
toCollection<? extends InternationalString>
in GeoAPI 4.0.- Parameters:
newValues
- the new delivery points, ornull
if none.
-
getElectronicMailAddresses
Returns the address of the electronic mailbox of the responsible organization or individual.- Specified by:
getElectronicMailAddresses
in interfaceorg.opengis.metadata.citation.Address
- Returns:
- address of the electronic mailbox of the responsible organization or individual.
-
setElectronicMailAddresses
Sets the address of the electronic mailbox of the responsible organization or individual.- Parameters:
newValues
- the new electronic mail addresses, ornull
if none.
-
getPostalCode
Returns ZIP or other postal code.- Specified by:
getPostalCode
in interfaceorg.opengis.metadata.citation.Address
- Returns:
- ZIP or other postal code, or
null
.
-
setPostalCode
Sets ZIP or other postal code.- Parameters:
newValue
- the new postal code, ornull
if none.
-