Class DefaultTelephone
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.DefaultTelephone
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.citation.Telephone
public class DefaultTelephone
extends ISOMetadata
implements org.opengis.metadata.citation.Telephone
Telephone numbers for contacting the responsible individual or organization.
The following property is mandatory in a well-formed metadata according ISO 19115:
CI_Telephone
└─number……
Telephone number by which individuals can contact responsible organisation or individual.Differences between versions 2003 and 2014 of ISO 19115
For any contact having more than one telephone number, the way to organize the information changed significantly between the two versions of ISO standard:- In ISO 19115:2003, each
Contact
had only oneTelephone
instance, but that instance could have an arbitrary number of "voice" and "facsimile" numbers. The methods (now deprecated) wereDefaultContact.getPhone()
,getVoices()
andgetFacsimiles()
. - In ISO 19115:2014, each
Contact
has an arbitrary number ofTelephone
instances, and each telephone has exactly one number. The new methods areDefaultContact.getPhones()
,getNumber()
andgetNumberType()
.
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.5
- 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 String
Telephone number by which individuals can contact responsible organization or individual.(package private) org.opengis.util.CodeList<?>
Type of telephone number.private Collection<org.opengis.metadata.citation.Telephone>
Deprecated.This field will be removed after we removed the deprecated public methods.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 a default telephone.DefaultTelephone
(String number, org.opengis.util.CodeList<?> numberType) Constructs a telephone with the given number and type.DefaultTelephone
(org.opengis.metadata.citation.Telephone object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultTelephone
castOrCopy
(org.opengis.metadata.citation.Telephone object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.final Collection<String>
Deprecated.As of ISO 19115:2014, replaced by a number codeTelephoneType.FACSIMILE
.Returns the telephone number by which individuals can contact responsible organization or individual.org.opengis.util.CodeList<?>
Returns the type of telephone number, ornull
if none.(package private) final Collection<org.opengis.metadata.citation.Telephone>
getOwner()
Returns the collection that own this telephone number, or create a new collection.final Collection<String>
Deprecated.As of ISO 19115:2014, replaced by a number withTelephoneType.VOICE
.void
setFacsimiles
(Collection<? extends String> newValues) Deprecated.As of ISO 19115:2014, replaced by a number withTelephoneType.FACSIMILE
.void
Sets the telephone number by which individuals can contact responsible organization or individual.void
setNumberType
(org.opengis.util.CodeList<?> newValue) Sets the type of telephone number.(package private) final DefaultTelephone
setOwner
(Collection<org.opengis.metadata.citation.Telephone> phones) Specifies the collection which contains this telephone number.void
setVoices
(Collection<? extends String> newValues) Deprecated.As of ISO 19115:2014, replaced by a number codeTelephoneType.VOICE
.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:
-
number
Telephone number by which individuals can contact responsible organization or individual. -
numberType
org.opengis.util.CodeList<?> numberTypeType of telephone number. -
owner
Deprecated.This field will be removed after we removed the deprecated public methods.For implementation ofgetVoices()
andgetFacsimiles()
deprecated methods. Shall be the telephones list of the enclosingDefaultContact
object.This field references the same collection than
DefaultContact.phones
when possible. Note that the link between this collection andDefaultContact.phones
is broken whenDefaultContact
is copied byMetadataCopier
, since theCloner.clone(Object)
method creates a new (unmodifiable) collection.
-
-
Constructor Details
-
DefaultTelephone
public DefaultTelephone()Constructs a default telephone. -
DefaultTelephone
DefaultTelephone(String number, org.opengis.util.CodeList<?> numberType) Constructs a telephone with the given number and type.- Parameters:
number
- the telephone number, ornull
.numberType
- the type of telephone number, ornull
.- Since:
- 0.5
-
DefaultTelephone
public DefaultTelephone(org.opengis.metadata.citation.Telephone 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
DefaultTelephone
, then it is returned unchanged. - Otherwise a new
DefaultTelephone
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
-
getNumber
Returns the telephone number by which individuals can contact responsible organization or individual.- Returns:
- telephone number by which individuals can contact responsible organization or individual.
- Since:
- 0.5
-
setNumber
Sets the telephone number by which individuals can contact responsible organization or individual.- Parameters:
newValue
- the new telephone number by which individuals can contact responsible organization or individual.- Since:
- 0.5
-
getNumberType
@UML(identifier="numberType", obligation=OPTIONAL, specification=ISO_19115) public org.opengis.util.CodeList<?> getNumberType()Returns the type of telephone number, ornull
if none. If non-null, the type can be"VOICE"
,"FACSIMILE"
or"SMS"
.Upcoming API change — specialization
The return type will be changed to theTelephoneType
code list when GeoAPI will provide it (tentatively in GeoAPI 3.1).- Returns:
- type of telephone number, or
null
if none. - Since:
- 0.5
-
setNumberType
public void setNumberType(org.opengis.util.CodeList<?> newValue) Sets the type of telephone number. If non-null, the type can only be"VOICE"
,"FACSIMILE"
or"SMS"
.Upcoming API change — specialization
The argument type will be changed to theTelephoneType
code list when GeoAPI will provide it (tentatively in GeoAPI 3.1). In the meantime, users can define their own code list class as below:- Parameters:
newValue
- the new type of telephone number.- Since:
- 0.5
-
setOwner
Specifies the collection which contains this telephone number. This method is invoked byDefaultContact.setPhones(Collection)
when the contact "takes possession" of aDefaultTelephone
.This method will be removed after we removed the deprecated public methods.
- Parameters:
phones
- the collection which should contain this telephone number.- Returns:
this
, or a copy of this instance if we conservatively choose to not modify this instance.
-
getOwner
Returns the collection that own this telephone number, or create a new collection. Creating a new collection is needed when this phone number has not yet been given to aDefaultContact
.This method will be removed after we removed the deprecated public methods.
-
getVoices
Deprecated.As of ISO 19115:2014, replaced by a number withTelephoneType.VOICE
.Returns the telephone numbers by which individuals can speak to the responsible organization or individual. This method searches in the contact phones, if the contact that own this phone is known.- Specified by:
getVoices
in interfaceorg.opengis.metadata.citation.Telephone
- Returns:
- telephone numbers by which individuals can speak to the responsible organization or individual.
-
setVoices
Deprecated.As of ISO 19115:2014, replaced by a number codeTelephoneType.VOICE
.Sets the telephone numbers by which individuals can speak to the responsible organization or individual. This method writes in the contact phones, if the contact that own this phone is known.- Parameters:
newValues
- the new telephone numbers, ornull
if none.
-
getFacsimiles
Deprecated.As of ISO 19115:2014, replaced by a number codeTelephoneType.FACSIMILE
.Returns the telephone numbers of a facsimile machine for the responsible organization or individual. This method searches in the contact phones, if the contact that own this phone is known.- Specified by:
getFacsimiles
in interfaceorg.opengis.metadata.citation.Telephone
- Returns:
- telephone numbers of a facsimile machine for the responsible organization or individual.
-
setFacsimiles
Deprecated.As of ISO 19115:2014, replaced by a number withTelephoneType.FACSIMILE
.Sets the telephone number of a facsimile machine for the responsible organization or individual. This method writes in the contact phones, if the contact that own this phone is known.- Parameters:
newValues
- the new telephone number, ornull
if none.
-