Class DefaultContact
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.DefaultContact
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.citation.Contact
Information required to enable contact with the responsible person and/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 Collection
<org.opengis.metadata.citation.Address> Physical and email addresses at which the organization or individual may be contacted.private org.opengis.util.InternationalString
Supplemental instructions on how or when to contact the individual or organization.private org.opengis.util.InternationalString
Type of the contact.private org.opengis.util.InternationalString
Time period (including time zone) when individuals can contact the organization or individual.private Collection
<org.opengis.metadata.citation.OnlineResource> On-line information that can be used to contact the individual or organization.private Collection
<org.opengis.metadata.citation.Telephone> Telephone numbers at which the organization or individual may be contacted.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 contact.DefaultContact
(org.opengis.metadata.citation.Contact object) Constructs a new instance initialized with the values from the specified metadata object.DefaultContact
(org.opengis.metadata.citation.OnlineResource resource) Constructs a contact initialized to the specified online resource. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultContact
castOrCopy
(org.opengis.metadata.citation.Contact object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.org.opengis.metadata.citation.Address
Deprecated.Collection
<org.opengis.metadata.citation.Address> Returns the physical and email addresses at which the organization or individual may be contacted.private Collection
<org.opengis.metadata.citation.Address> org.opengis.util.InternationalString
Returns supplemental instructions on how or when to contact the individual or organization.org.opengis.util.InternationalString
Type of the contact.org.opengis.util.InternationalString
Returns the time period (including time zone) when individuals can contact the organization or individual.org.opengis.metadata.citation.OnlineResource
Deprecated.As of ISO 19115:2014, replaced bygetOnlineResources()
.private Collection
<org.opengis.metadata.citation.OnlineResource> Collection
<org.opengis.metadata.citation.OnlineResource> Returns on-line information that can be used to contact the individual or organization.org.opengis.metadata.citation.Telephone
getPhone()
Deprecated.As of ISO 19115:2014, replaced bygetPhones()
.private Collection
<org.opengis.metadata.citation.Telephone> Invoked by JAXB at both marshalling and unmarshalling time.Collection
<org.opengis.metadata.citation.Telephone> Returns telephone numbers at which the organization or individual may be contacted.void
setAddress
(org.opengis.metadata.citation.Address newValue) Deprecated.As of ISO 19115:2014, replaced bysetAddresses(Collection)
.void
setAddresses
(Collection<? extends org.opengis.metadata.citation.Address> newValues) Sets the physical and email addresses at which the organization or individual may be contacted.void
setContactInstructions
(org.opengis.util.InternationalString newValue) Sets supplemental instructions on how or when to contact the individual or organization.void
setContactType
(org.opengis.util.InternationalString newValue) Sets new type of the contact.void
setHoursOfService
(org.opengis.util.InternationalString newValue) Sets time period (including time zone) when individuals can contact the organization or individual.void
setOnlineResource
(org.opengis.metadata.citation.OnlineResource newValue) Deprecated.As of ISO 19115:2014, replaced bysetOnlineResources(Collection)
.void
setOnlineResources
(Collection<? extends org.opengis.metadata.citation.OnlineResource> newValues) Sets on-line information that can be used to contact the individual or organization.void
setPhone
(org.opengis.metadata.citation.Telephone newValue) Deprecated.As of ISO 19115:2014, replaced bysetPhones(Collection)
.void
setPhones
(Collection<? extends org.opengis.metadata.citation.Telephone> newValues) Sets telephone numbers at which the organization or individual may be contacted.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:
-
phones
Telephone numbers at which the organization or individual may be contacted. -
addresses
Physical and email addresses at which the organization or individual may be contacted. -
onlineResources
On-line information that can be used to contact the individual or organization. -
hoursOfService
private org.opengis.util.InternationalString hoursOfServiceTime period (including time zone) when individuals can contact the organization or individual. -
contactInstructions
private org.opengis.util.InternationalString contactInstructionsSupplemental instructions on how or when to contact the individual or organization. -
contactType
private org.opengis.util.InternationalString contactTypeType of the contact.
-
-
Constructor Details
-
DefaultContact
public DefaultContact()Constructs an initially empty contact. -
DefaultContact
public DefaultContact(org.opengis.metadata.citation.OnlineResource resource) Constructs a contact initialized to the specified online resource.- Parameters:
resource
- the on-line information that can be used to contact the individual or organization, ornull
if none.
-
DefaultContact
public DefaultContact(org.opengis.metadata.citation.Contact 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
DefaultContact
, then it is returned unchanged. - Otherwise a new
DefaultContact
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
-
getPhones
@UML(identifier="phone", obligation=OPTIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.citation.Telephone> getPhones()Returns telephone numbers at which the organization or individual may be contacted.- Returns:
- telephone numbers at which the organization or individual may be contacted.
- Since:
- 0.5
-
setPhones
Sets telephone numbers at which the organization or individual may be contacted.- Parameters:
newValues
- the new telephones.- Since:
- 0.5
-
getPhone
Deprecated.As of ISO 19115:2014, replaced bygetPhones()
.Returns telephone numbers at which the organization or individual may be contacted. This method returns the first telephone number associated toTelephoneType.VOICE
orTelephoneType.FACSIMILE FACSIMILE
.- Specified by:
getPhone
in interfaceorg.opengis.metadata.citation.Contact
- Returns:
- telephone numbers at which the organization or individual may be contacted, or
null
.
-
setPhone
Deprecated.As of ISO 19115:2014, replaced bysetPhones(Collection)
.Sets telephone numbers at which the organization or individual may be contacted. This method delegates tosetPhones(Collection)
.- Parameters:
newValue
- the new telephone, ornull
if none.
-
getAddresses
@UML(identifier="address", obligation=OPTIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.citation.Address> getAddresses()Returns the physical and email addresses at which the organization or individual may be contacted.- Returns:
- physical and email addresses at which the organization or individual may be contacted, or
null
. - Since:
- 0.5
-
setAddresses
Sets the physical and email addresses at which the organization or individual may be contacted.- Parameters:
newValues
- the new addresses.- Since:
- 0.5
-
getAddress
Deprecated.As of ISO 19115:2014, replaced bygetAddresses()
.Returns the physical and email address at which the organization or individual may be contacted. This method returns the firstadress
element, or null if none.- Specified by:
getAddress
in interfaceorg.opengis.metadata.citation.Contact
- Returns:
- physical and email address at which the organization or individual may be contacted, or
null
.
-
setAddress
Deprecated.As of ISO 19115:2014, replaced bysetAddresses(Collection)
.Sets the physical and email address at which the organization or individual may be contacted. This method delegates tosetAddresses(Collection)
.- Parameters:
newValue
- the new address, ornull
if none.
-
getOnlineResources
@UML(identifier="onlineResource", obligation=OPTIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.citation.OnlineResource> getOnlineResources()Returns on-line information that can be used to contact the individual or organization.- Returns:
- on-line information that can be used to contact the individual or organization.
- Since:
- 0.5
-
setOnlineResources
public void setOnlineResources(Collection<? extends org.opengis.metadata.citation.OnlineResource> newValues) Sets on-line information that can be used to contact the individual or organization.- Parameters:
newValues
- the new online resources.- Since:
- 0.5
-
getOnlineResource
Deprecated.As of ISO 19115:2014, replaced bygetOnlineResources()
.Returns on-line information that can be used to contact the individual or organization. This method returns the firstonline resource
element, or null if none.- Specified by:
getOnlineResource
in interfaceorg.opengis.metadata.citation.Contact
- Returns:
- on-line information that can be used to contact the individual or organization, or
null
.
-
setOnlineResource
Deprecated.As of ISO 19115:2014, replaced bysetOnlineResources(Collection)
.Sets on-line information that can be used to contact the individual or organization. This method delegates tosetOnlineResources(Collection)
.- Parameters:
newValue
- the new online resource, ornull
if none.
-
getHoursOfService
public org.opengis.util.InternationalString getHoursOfService()Returns the time period (including time zone) when individuals can contact the organization or individual.Upcoming API change — multiplicity
As of ISO 19115:2014, this singleton has been replaced by a collection. This change will tentatively be applied in GeoAPI 4.0.- Specified by:
getHoursOfService
in interfaceorg.opengis.metadata.citation.Contact
- Returns:
- time period when individuals can contact the organization or individual.
-
setHoursOfService
public void setHoursOfService(org.opengis.util.InternationalString newValue) Sets time period (including time zone) when individuals can contact the organization or individual.Upcoming API change — multiplicity
As of ISO 19115:2014, this singleton has been replaced by a collection. This change will tentatively be applied in GeoAPI 4.0.- Parameters:
newValue
- the new hours of service.
-
getContactInstructions
public org.opengis.util.InternationalString getContactInstructions()Returns supplemental instructions on how or when to contact the individual or organization.- Specified by:
getContactInstructions
in interfaceorg.opengis.metadata.citation.Contact
- Returns:
- supplemental instructions on how or when to contact the individual or organization, or
null
.
-
setContactInstructions
public void setContactInstructions(org.opengis.util.InternationalString newValue) Sets supplemental instructions on how or when to contact the individual or organization.- Parameters:
newValue
- the new contact instructions, ornull
if none.
-
getContactType
@UML(identifier="contactType", obligation=OPTIONAL, specification=ISO_19115) public org.opengis.util.InternationalString getContactType()Type of the contact. Returnsnull
if none.- Returns:
- type of the contact, or
null
if none. - Since:
- 0.5
-
setContactType
public void setContactType(org.opengis.util.InternationalString newValue) Sets new type of the contact.- Parameters:
newValue
- the new type of the contact.- Since:
- 0.5
-
getPhoneList
Invoked by JAXB at both marshalling and unmarshalling time. This attribute has been added by ISO 19115:2014 standard. If (and only if) marshalling an older standard version, we omit this attribute. -
getAddressList
-
getOnlineResourceList
-
getAddresses()
.