Class AbstractParty

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

AbstractParty

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object

Direct Known Subclasses:

Default­Individual, Default­Organisation

@TitleProperty(name="name")
@UML(identifier="CI_Party",
     specification=ISO_19115)
public class AbstractParty
extends ISOMetadata

Information about the individual and / or organization of the party. The following property is conditional (i.e. mandatory under some circumstances) in a well-formed metadata according ISO 19115:

CI_Party └─name…… Name of the party.

Note on International Standard versions
This class is derived from a new type defined in the ISO 19115 international standard published in 2014, while GeoAPI 3.0 is based on the version published in 2003. Consequently this implementation class does not yet implement a GeoAPI interface, but is expected to do so after the next GeoAPI releases. When the interface will become available, all references to this implementation class in Apache SIS will be replaced be references to the Party interface.

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:

• 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
Abstract­Party()	Constructs an initially empty party.
Abstract­Party(Char­Sequence name, Contact contact­Info)	Constructs a party initialized with the specified name and contact information.
Abstract­Party(Abstract­Party object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
Collection<Contact>	get­Contact­Info()	Returns the contact information for the party.
Collection<Identifier>	get­Identifiers()	Identifiers of the party.
International­String	get­Name()	Return the name of the party.
void	set­Contact­Info(Collection<? extends Contact> new­Values)	Sets the contact information for the party.
void	set­Identifiers(Collection<? extends Identifier> new­Values)	Sets the identifiers of the party.
void	set­Name(International­String new­Value)	Sets the name of the party.

Methods inherited from class ISOMetadata

get­Identifier, get­Identifier­Map, 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.
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

AbstractParty

public AbstractParty()

Constructs an initially empty party.

AbstractParty

public AbstractParty(CharSequence name,
 Contact contactInfo)

Constructs a party initialized with the specified name and contact information.

Parameters:

name - name of the party, or null if none.

contact­Info - contact information for the party, or null if none.

AbstractParty

public AbstractParty(AbstractParty 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.

Method Details

getName

@UML(identifier="name",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public InternationalString getName()

Return the name of the party.

Returns:

name of the party.

setName

public void setName(InternationalString newValue)

Sets the name of the party.

Parameters:

new­Value - the new name of the party.

getIdentifiers

public Collection<Identifier> getIdentifiers()

Identifiers of the party.

Unified identifiers view

In this SIS implementation, the collection returned by this method includes the XML identifiers (ID, UUID, etc.), thus providing a unified view of every kind of identifiers associated with this party.

XML marshalling note

The <mac:identifier> element marshalled to XML will exclude all the above cited identifiers, for compliance with ISO 19115 model. Those identifiers will appear in other XML elements or attributes.

Specified by:

get­Identifiers in interface Identified­Object

Overrides:

get­Identifiers in class ISOMetadata

Returns:

identifiers of the party, or an empty collection if none.

Since:

1.3

See Also:

• Default­Citation.get­Identifiers()
• Default­Objective.get­Identifiers()
• Abstract­Identified­Object.get­Identifiers()

setIdentifiers

public void setIdentifiers(Collection<? extends Identifier> newValues)

Sets the identifiers of the party.

XML identifiers (ID, UUID, etc.), are not affected by this method, unless they are explicitly provided in the given collection.

Parameters:

new­Values - the new identifiers values.

Since:

1.3

getContactInfo

@UML(identifier="contactInfo",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<Contact> getContactInfo()

Returns the contact information for the party.

Returns:

contact information for the party.

setContactInfo

public void setContactInfo(Collection<? extends Contact> newValues)

Sets the contact information for the party.

Parameters:

new­Values - the new contact information for the party.