Class DefaultContact

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultContact

All Implemented Interfaces:

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

public class DefaultContact
extends ISOMetadata
implements 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

See Also:

• 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­Contact()	Constructs an initially empty contact.
Default­Contact(Contact object)	Constructs a new instance initialized with the values from the specified metadata object.
Default­Contact(Online­Resource resource)	Constructs a contact initialized to the specified online resource.

Method Summary

Modifier and Type	Method	Description
static Default­Contact	cast­Or­Copy(Contact object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Address	get­Address()	Deprecated. As of ISO 19115:2014, replaced by get­Addresses().
Collection<Address>	get­Addresses()	Returns the physical and email addresses at which the organization or individual may be contacted.
International­String	get­Contact­Instructions()	Returns supplemental instructions on how or when to contact the individual or organization.
International­String	get­Contact­Type()	Type of the contact.
International­String	get­Hours­Of­Service()	Returns the time period (including time zone) when individuals can contact the organization or individual.
Online­Resource	get­Online­Resource()	Deprecated. As of ISO 19115:2014, replaced by get­Online­Resources().
Collection<Online­Resource>	get­Online­Resources()	Returns on-line information that can be used to contact the individual or organization.
Telephone	get­Phone()	Deprecated. As of ISO 19115:2014, replaced by get­Phones().
Collection<Telephone>	get­Phones()	Returns telephone numbers at which the organization or individual may be contacted.
void	set­Address(Address new­Value)	Deprecated. As of ISO 19115:2014, replaced by set­Addresses(Collection).
void	set­Addresses(Collection<? extends Address> new­Values)	Sets the physical and email addresses at which the organization or individual may be contacted.
void	set­Contact­Instructions(International­String new­Value)	Sets supplemental instructions on how or when to contact the individual or organization.
void	set­Contact­Type(International­String new­Value)	Sets new type of the contact.
void	set­Hours­Of­Service(International­String new­Value)	Sets time period (including time zone) when individuals can contact the organization or individual.
void	set­Online­Resource(Online­Resource new­Value)	Deprecated. As of ISO 19115:2014, replaced by set­Online­Resources(Collection).
void	set­Online­Resources(Collection<? extends Online­Resource> new­Values)	Sets on-line information that can be used to contact the individual or organization.
void	set­Phone(Telephone new­Value)	Deprecated. As of ISO 19115:2014, replaced by set­Phones(Collection).
void	set­Phones(Collection<? extends Telephone> new­Values)	Sets telephone numbers at which the organization or individual may be contacted.

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

DefaultContact

public DefaultContact()

Constructs an initially empty contact.

DefaultContact

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

DefaultContact

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

See Also:

• cast­Or­Copy(Contact)

Method Details

castOrCopy

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

getPhones

@UML(identifier="phone",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<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

public void setPhones(Collection<? extends Telephone> newValues)

Sets telephone numbers at which the organization or individual may be contacted.

Parameters:

new­Values - the new telephones.

Since:

0.5

getPhone

@Deprecated(since="1.0")
public Telephone getPhone()

Deprecated.

As of ISO 19115:2014, replaced by get­Phones().

Returns telephone numbers at which the organization or individual may be contacted. This method returns the first telephone number associated with Telephone­Type.VOICE or Telephone­Type.FACSIMILE FACSIMILE.

Specified by:

get­Phone in interface Contact

Returns:

telephone numbers at which the organization or individual may be contacted, or null.

setPhone

@Deprecated(since="1.0")
public void setPhone(Telephone newValue)

Deprecated.

As of ISO 19115:2014, replaced by set­Phones(Collection).

Sets telephone numbers at which the organization or individual may be contacted. This method delegates to set­Phones(Collection).

Parameters:

new­Value - the new telephone, or null if none.

getAddresses

@UML(identifier="address",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<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

public void setAddresses(Collection<? extends Address> newValues)

Sets the physical and email addresses at which the organization or individual may be contacted.

Parameters:

new­Values - the new addresses.

Since:

0.5

getAddress

@Deprecated(since="1.0")
public Address getAddress()

Deprecated.

As of ISO 19115:2014, replaced by get­Addresses().

Returns the physical and email address at which the organization or individual may be contacted. This method returns the first adress element, or null if none.

Specified by:

get­Address in interface Contact

Returns:

physical and email address at which the organization or individual may be contacted, or null.

setAddress

@Deprecated(since="1.0")
public void setAddress(Address newValue)

Deprecated.

As of ISO 19115:2014, replaced by set­Addresses(Collection).

Sets the physical and email address at which the organization or individual may be contacted. This method delegates to set­Addresses(Collection).

Parameters:

new­Value - the new address, or null if none.

getOnlineResources

@UML(identifier="onlineResource",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<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 OnlineResource> newValues)

Sets on-line information that can be used to contact the individual or organization.

Parameters:

new­Values - the new online resources.

Since:

0.5

getOnlineResource

@Deprecated(since="1.0")
public OnlineResource getOnlineResource()

Deprecated.

As of ISO 19115:2014, replaced by get­Online­Resources().

Returns on-line information that can be used to contact the individual or organization. This method returns the first online resource element, or null if none.

Specified by:

get­Online­Resource in interface Contact

Returns:

on-line information that can be used to contact the individual or organization, or null.

setOnlineResource

@Deprecated(since="1.0")
public void setOnlineResource(OnlineResource newValue)

Deprecated.

As of ISO 19115:2014, replaced by set­Online­Resources(Collection).

Sets on-line information that can be used to contact the individual or organization. This method delegates to set­Online­Resources(Collection).

Parameters:

new­Value - the new online resource, or null if none.

getHoursOfService

public 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:

get­Hours­Of­Service in interface Contact

Returns:

time period when individuals can contact the organization or individual.

setHoursOfService

public void setHoursOfService(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:

new­Value - the new hours of service.

getContactInstructions

public InternationalString getContactInstructions()

Returns supplemental instructions on how or when to contact the individual or organization.

Specified by:

get­Contact­Instructions in interface Contact

Returns:

supplemental instructions on how or when to contact the individual or organization, or null.

setContactInstructions

public void setContactInstructions(InternationalString newValue)

Sets supplemental instructions on how or when to contact the individual or organization.

Parameters:

new­Value - the new contact instructions, or null if none.

getContactType

@UML(identifier="contactType",
     obligation=OPTIONAL,
     specification=ISO_19115)
public InternationalString getContactType()

Type of the contact. Returns null if none.

Returns:

type of the contact, or null if none.

Since:

0.5

setContactType

public void setContactType(InternationalString newValue)

Sets new type of the contact.

Parameters:

new­Value - the new type of the contact.

Since:

0.5