Class DefaultTelephone

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultTelephone

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Telephone

@TitleProperty(name="number")
public class DefaultTelephone
extends ISOMetadata
implements 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 one Telephone instance, but that instance could have an arbitrary number of "voice" and "facsimile" numbers. The methods (now deprecated) were Default­Contact.get­Phone(), get­Voices() and get­Facsimiles().
• In ISO 19115:2014, each Contact has an arbitrary number of Telephone instances, and each telephone has exactly one number. The new methods are Default­Contact.get­Phones(), get­Number() and get­Number­Type().

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

See Also:

• Default­Contact.get­Phones()
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ModifiableMetadata

Modifiable­Metadata.State

Modifier and Type	Class	Description
static enum	Modifiable­Metadata.State	Whether the metadata is still editable or has been made final.

Field Summary

Fields inherited from class ISOMetadata

identifiers

Modifier and Type	Field	Description
protected Collection<Identifier>	identifiers	All identifiers associated with this metadata, or null if none.

Constructor Summary

Constructors

Constructor	Description
Default­Telephone()	Constructs a default telephone.
Default­Telephone(Telephone object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Telephone	cast­Or­Copy(Telephone object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
final Collection<String>	get­Facsimiles()	Deprecated. As of ISO 19115:2014, replaced by a number code Telephone­Type.FACSIMILE.
String	get­Number()	Returns the telephone number by which individuals can contact responsible organization or individual.
Code­List<?>	get­Number­Type()	Returns the type of telephone number, or null if none.
final Collection<String>	get­Voices()	Deprecated. As of ISO 19115:2014, replaced by a number with Telephone­Type.VOICE.
void	set­Facsimiles(Collection<? extends String> new­Values)	Deprecated. As of ISO 19115:2014, replaced by a number with Telephone­Type.FACSIMILE.
void	set­Number(String new­Value)	Sets the telephone number by which individuals can contact responsible organization or individual.
void	set­Number­Type(Code­List<?> new­Value)	Sets the type of telephone number.
void	set­Voices(Collection<? extends String> new­Values)	Deprecated. As of ISO 19115:2014, replaced by a number code Telephone­Type.VOICE.

Methods inherited from class ISOMetadata

get­Identifier, get­Identifier­Map, get­Identifiers, get­Standard, set­Identifier

Modifier and Type	Method	Description
protected Identifier	get­Identifier()	Returns the first identifier which is presumed to be defined by ISO 19115 conceptual model.
Identifier­Map	get­Identifier­Map()	A map view of the identifiers collection as (authority, code) entries.
Collection<Identifier>	get­Identifiers()	Returns all identifiers associated with this object (from conceptual model and from XML document).
Metadata­Standard	get­Standard()	Returns the metadata standard implemented by subclasses, which is ISO 19115.
protected void	set­Identifier(Identifier new­Value)	Sets the identifier for metadata objects that are expected to contain at most one ISO 19115 identifier.

Methods inherited from class ModifiableMetadata

check­Write­Permission, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, merge, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, write­Set

Modifier and Type	Method	Description
protected void	check­Write­Permission(Object current)	Checks if changes in the metadata are allowed.
protected static <E> Collection<E>	copy­Collection(Collection<? extends E> source, Class<E> element­Type)	Creates a list or set with the content of the source collection, or returns null if the source is null or empty.
protected static <E> List<E>	copy­List(Collection<? extends E> source, Class<E> element­Type)	Creates a list with the content of the source collection, or returns null if the source is null or empty.
protected static <K,V> Map<K,V>	copy­Map(Map<? extends K, ? extends V> source, Class<K> key­Type)	Creates a map with the content of the source map, or returns null if the source is null or empty.
protected static <E> Set<E>	copy­Set(Collection<? extends E> source, Class<E> element­Type)	Creates a set with the content of the source collection, or returns null if the source is null or empty.
Modifiable­Metadata	deep­Copy(Modifiable­Metadata.State target)	Copies (if necessary) this metadata and all its children.
void	merge(Object source)	Merges the data from the given source into this metadata.
protected final <E> Collection<E>	non­Null­Collection(Collection<E> current, Class<E> element­Type)	Returns the specified collection, or a new one if current is null.
protected final <E> List<E>	non­Null­List(List<E> current, Class<E> element­Type)	Returns the specified list, or a new one if current is null.
protected final <K,V> Map<K,V>	non­Null­Map(Map<K,V> current, Class<K> key­Type)	Returns the specified map, or a new one if current is null.
protected final <E> Set<E>	non­Null­Set(Set<E> current, Class<E> element­Type)	Returns the specified set, or a new one if current is null.
protected static <E> Collection<E>	singleton(E value, Class<E> element­Type)	Creates a singleton list or set containing only the given value, if non-null.
Modifiable­Metadata.State	state()	Tells whether this instance of metadata is editable.
protected final <E> Collection<E>	write­Collection(Collection<? extends E> source, Collection<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list or set, creating it if needed.
protected final <E> List<E>	write­List(Collection<? extends E> source, List<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list, creating it if needed.
protected final <K,V> Map<K,V>	write­Map(Map<? extends K, ? extends V> source, Map<K,V> target, Class<K> key­Type)	Writes the content of the source map into the target map, creating it if needed.
protected final <E> Set<E>	write­Set(Collection<? extends E> source, Set<E> target, Class<E> element­Type)	Writes the content of the source collection into the target set, creating it if needed.

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, clone, equals, equals, get­Interface, get­Standard­Type, hash­Code, is­Empty, nil­Reasons, prune, to­String

Modifier and Type	Method	Description
Map<String,Object>	as­Map()	Returns a view of the property values in a Map.
Tree­Table	as­Tree­Table()	Returns the property types and values as a tree table.
protected Abstract­Metadata	clone()	Returns a shallow clone of this metadata.
final boolean	equals(Object object)	Performs a strict comparison of this metadata with the given object.
boolean	equals(Object object, Comparison­Mode mode)	Compares this metadata with the specified object for equality.
final Class<?>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Metadata.get­Standard­Type() for integration with Lenient­Comparable.
Type	get­Standard­Type()	Returns the metadata interface implemented by this class.
int	hash­Code()	Computes a hash code value for this metadata using Java reflection.
boolean	is­Empty()	Returns true if this metadata contains only null, nil or empty properties.
Map<String, Nil­Reason>	nil­Reasons()	Returns a view of the reasons why some properties are missing.
void	prune()	Removes all references to empty properties.
String	to­String()	Returns a string representation of this metadata.

Methods inherited from class Object

finalize, get­Class, notify, notify­All, wait, wait, wait

Constructor Details

DefaultTelephone

public DefaultTelephone()

Constructs a default telephone.

DefaultTelephone

public DefaultTelephone(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, or null if none.

See Also:

• cast­Or­Copy(Telephone)

Method Details

castOrCopy

public static DefaultTelephone castOrCopy(Telephone 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 Default­Telephone, then it is returned unchanged.
• Otherwise a new Default­Telephone 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.

getNumber

@UML(identifier="number",
     obligation=MANDATORY,
     specification=ISO_19115)
public String 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

public void setNumber(String newValue)

Sets the telephone number by which individuals can contact responsible organization or individual.

Parameters:

new­Value - 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 CodeList<?> getNumberType()

Returns the type of telephone number, or null if none. If non-null, the type can be "VOICE", "FACSIMILE" or "SMS".

Upcoming API change — specialization
The return type will be changed to the Telephone­Type 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(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 the Telephone­Type 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:

final class UnsupportedCodeList extends CodeList<UnsupportedCodeList> {
    private static final List<UnsupportedCodeList> VALUES = new ArrayList<UnsupportedCodeList>();

    // Need to declare at least one code list element.
    public static final UnsupportedCodeList MY_CODE_LIST = new UnsupportedCodeList("MY_CODE_LIST");

    private UnsupportedCodeList(String name) {
        super(name, VALUES);
    }

    public static UnsupportedCodeList valueOf(String code) {
        return valueOf(UnsupportedCodeList.class, code);
    }

    @Override
    public UnsupportedCodeList[] family() {
        synchronized (VALUES) {
            return VALUES.toArray(new UnsupportedCodeList[VALUES.size()]);
        }
    }
}

Parameters:

new­Value - the new type of telephone number.

Since:

0.5

getVoices

@Deprecated(since="1.0")
public final Collection<String> getVoices()

Deprecated.

As of ISO 19115:2014, replaced by a number with Telephone­Type.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:

get­Voices in interface Telephone

Returns:

telephone numbers by which individuals can speak to the responsible organization or individual.

setVoices

@Deprecated(since="1.0")
public void setVoices(Collection<? extends String> newValues)

Deprecated.

As of ISO 19115:2014, replaced by a number code Telephone­Type.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:

new­Values - the new telephone numbers, or null if none.

getFacsimiles

@Deprecated(since="1.0")
public final Collection<String> getFacsimiles()

Deprecated.

As of ISO 19115:2014, replaced by a number code Telephone­Type.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:

get­Facsimiles in interface Telephone

Returns:

telephone numbers of a facsimile machine for the responsible organization or individual.

setFacsimiles

@Deprecated(since="1.0")
public void setFacsimiles(Collection<? extends String> newValues)

Deprecated.

As of ISO 19115:2014, replaced by a number with Telephone­Type.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:

new­Values - the new telephone number, or null if none.