Class DefaultExtendedElementInformation

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultExtendedElementInformation

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Extended­Element­Information

@TitleProperty(name="name")
public class DefaultExtendedElementInformation
extends ISOMetadata
implements ExtendedElementInformation

New metadata element, not found in ISO 19115, which is required to describe geographic data. Metadata elements are contained in a metadata extension information. The following properties are mandatory or conditional (i.e. mandatory under some circumstances) in a well-formed metadata according ISO 19115:

MD_Extended­Element­Information ├─name……………………………………………………… Name of the extended metadata element. ├─definition……………………………………… Definition of the extended element. ├─obligation……………………………………… Obligation of the extended element. ├─condition………………………………………… Condition under which the extended element is mandatory. ├─data­Type…………………………………………… Code which identifies the kind of value provided in the extended element. ├─maximum­Occurrence…………………… Maximum occurrence of the extended element. ├─domain­Value…………………………………… Valid values that can be assigned to the extended element. ├─parent­Entity………………………………… Name of the metadata entity(s) under which this extended metadata element may appear. ├─rule……………………………………………………… Specifies how the extended element relates to other existing elements and entities. └─source………………………………………………… Name of the person or organisation creating the extended element. ├─party………………………………………… Information about the parties. │ └─name………………………………… Name of the party. └─role…………………………………………… Function performed by the responsible party.

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­Extended­Element­Information()	Construct an initially empty extended element information.
Default­Extended­Element­Information(String name, Char­Sequence definition, Char­Sequence condition, Datatype data­Type, String parent­Entity, Char­Sequence rule, Responsible­Party source)	Create an extended element information initialized to the given values.
Default­Extended­Element­Information(Extended­Element­Information object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Extended­Element­Information	cast­Or­Copy(Extended­Element­Information object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
International­String	get­Condition()	Condition under which the extended element is mandatory.
Datatype	get­Data­Type()	Code which identifies the kind of value provided in the extended element.
International­String	get­Definition()	Definition of the extended element.
Integer	get­Domain­Code()	Deprecated. Removed as of ISO 19115:2014.
International­String	get­Domain­Value()	Valid values that can be assigned to the extended element.
Integer	get­Maximum­Occurrence()	Maximum occurrence of the extended element.
String	get­Name()	Name of the extended metadata element.
Obligation	get­Obligation()	Obligation of the extended element.
Collection<String>	get­Parent­Entity()	Name of the metadata entity(s) under which this extended metadata element may appear.
International­String	get­Rationale()	Returns the reason for creating the extended element.
Collection<International­String>	get­Rationales()	Deprecated. As of ISO 19115:2014, replaced by get­Rationale().
International­String	get­Rule()	Specifies how the extended element relates to other existing elements and entities.
String	get­Short­Name()	Deprecated. Removed as of ISO 19115:2014.
Collection<Responsible­Party>	get­Sources()	Name of the person or organization creating the extended element.
void	set­Condition(International­String new­Value)	Sets the condition under which the extended element is mandatory.
void	set­Data­Type(Datatype new­Value)	Sets the code which identifies the kind of value provided in the extended element.
void	set­Definition(International­String new­Value)	Sets the definition of the extended element.
void	set­Domain­Code(Integer new­Value)	Deprecated. Removed as of ISO 19115:2014.
void	set­Domain­Value(International­String new­Value)	Sets the valid values that can be assigned to the extended element.
void	set­Maximum­Occurrence(Integer new­Value)	Sets the maximum occurrence of the extended element.
void	set­Name(String new­Value)	Sets the name of the extended metadata element.
void	set­Obligation(Obligation new­Value)	Sets the obligation of the extended element.
void	set­Parent­Entity(Collection<? extends String> new­Values)	Sets the name of the metadata entity(s) under which this extended metadata element may appear.
void	set­Rationale(International­String new­Value)	Sets the reason for creating the extended element.
void	set­Rationales(Collection<? extends International­String> new­Values)	Deprecated. As of ISO 19115:2014, replaced by set­Rationale(International­String).
void	set­Rule(International­String new­Value)	Sets how the extended element relates to other existing elements and entities.
void	set­Short­Name(String new­Value)	Deprecated. Removed as of ISO 19115:2014.
void	set­Sources(Collection<? extends Responsible­Party> new­Values)	Sets the name of the person or organization creating the extended element.

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

DefaultExtendedElementInformation

public DefaultExtendedElementInformation()

Construct an initially empty extended element information.

DefaultExtendedElementInformation

public DefaultExtendedElementInformation(String name,
 CharSequence definition,
 CharSequence condition,
 Datatype dataType,
 String parentEntity,
 CharSequence rule,
 ResponsibleParty source)

Create an extended element information initialized to the given values.

Parameters:

name - the name of the extended metadata element.

definition - the definition of the extended element.

condition - the condition under which the extended element is mandatory.

data­Type - the code which identifies the kind of value provided in the extended element.

parent­Entity - the name of the metadata entity(s) under which this extended metadata element may appear.

rule - how the extended element relates to other existing elements and entities.

source - the name of the person or organization creating the extended element.

DefaultExtendedElementInformation

public DefaultExtendedElementInformation(ExtendedElementInformation 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.

Note on properties validation

This constructor does not verify the property values of the given metadata (e.g. whether it contains unexpected negative values). This is because invalid metadata exist in practice, and verifying their validity in this copy constructor is often too late. Note that this is not the only hole, as invalid metadata instances can also be obtained by unmarshalling an invalid XML document.

Parameters:

object - the metadata to copy values from, or null if none.

See Also:

• cast­Or­Copy(Extended­Element­Information)

Method Details

castOrCopy

public static DefaultExtendedElementInformation castOrCopy(ExtendedElementInformation 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­Extended­Element­Information, then it is returned unchanged.
• Otherwise a new Default­Extended­Element­Information 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.

getName

public String getName()

Name of the extended metadata element.

Specified by:

get­Name in interface Extended­Element­Information

Returns:

name of the extended metadata element, or null.

setName

public void setName(String newValue)

Sets the name of the extended metadata element.

Parameters:

new­Value - the new name.

getShortName

@Deprecated(since="1.0")
public String getShortName()

Deprecated.

Removed as of ISO 19115:2014.

Short form suitable for use in an implementation method such as XML or SGML.

Specified by:

get­Short­Name in interface Extended­Element­Information

Returns:

short form suitable for use in an implementation method such as XML or SGML, or null.

setShortName

@Deprecated(since="1.0")
public void setShortName(String newValue)

Deprecated.

Removed as of ISO 19115:2014.

Sets a short form suitable for use in an implementation method such as XML or SGML.

Parameters:

new­Value - the new short name.

getDomainCode

@Deprecated(since="1.0")
public Integer getDomainCode()

Deprecated.

Removed as of ISO 19115:2014.

Three digit code assigned to the extended element. Returns a non-null value only if the data type is code list element.

Specified by:

get­Domain­Code in interface Extended­Element­Information

Returns:

three digit code assigned to the extended element, or null.

setDomainCode

@Deprecated(since="1.0")
public void setDomainCode(Integer newValue)

Deprecated.

Removed as of ISO 19115:2014.

Sets a three digit code assigned to the extended element.

Parameters:

new­Value - the new domain code.

getDefinition

public InternationalString getDefinition()

Definition of the extended element.

Specified by:

get­Definition in interface Extended­Element­Information

Returns:

definition of the extended element, or null.

setDefinition

public void setDefinition(InternationalString newValue)

Sets the definition of the extended element.

Parameters:

new­Value - the new definition.

getObligation

public Obligation getObligation()

Obligation of the extended element.

Specified by:

get­Obligation in interface Extended­Element­Information

Returns:

obligation of the extended element, or null.

setObligation

public void setObligation(Obligation newValue)

Sets the obligation of the extended element.

Parameters:

new­Value - the new obligation.

getCondition

public InternationalString getCondition()

Condition under which the extended element is mandatory. Returns a non-null value only if the obligation is conditional.

Specified by:

get­Condition in interface Extended­Element­Information

Returns:

the condition under which the extended element is mandatory, or null.

setCondition

public void setCondition(InternationalString newValue)

Sets the condition under which the extended element is mandatory.

Parameters:

new­Value - the new condition.

getDataType

public Datatype getDataType()

Code which identifies the kind of value provided in the extended element.

Specified by:

get­Data­Type in interface Extended­Element­Information

Returns:

the kind of value provided in the extended element, or null.

setDataType

public void setDataType(Datatype newValue)

Sets the code which identifies the kind of value provided in the extended element.

Parameters:

new­Value - the new data type.

getMaximumOccurrence

@ValueRange(minimum=0.0)
public Integer getMaximumOccurrence()

Maximum occurrence of the extended element. Returns null if it does not apply, for example if the data type is enumeration, code list or code list element.

Specified by:

get­Maximum­Occurrence in interface Extended­Element­Information

Returns:

maximum occurrence of the extended element, or null.

setMaximumOccurrence

public void setMaximumOccurrence(Integer newValue)

Sets the maximum occurrence of the extended element.

Parameters:

new­Value - the new maximum occurrence, or null.

Throws:

Illegal­Argument­Exception - if the given value is negative.

getDomainValue

public InternationalString getDomainValue()

Valid values that can be assigned to the extended element. Returns null if it doesn't apply, for example if the data type is enumeration, code list or code list element.

Specified by:

get­Domain­Value in interface Extended­Element­Information

Returns:

valid values that can be assigned to the extended element, or null.

setDomainValue

public void setDomainValue(InternationalString newValue)

Sets the valid values that can be assigned to the extended element.

Parameters:

new­Value - the new domain value.

getParentEntity

public Collection<String> getParentEntity()

Name of the metadata entity(s) under which this extended metadata element may appear. The name(s) may be standard metadata element(s) or other extended metadata element(s).

Specified by:

get­Parent­Entity in interface Extended­Element­Information

Returns:

name of the metadata entity(s) under which this extended metadata element may appear.

setParentEntity

public void setParentEntity(Collection<? extends String> newValues)

Sets the name of the metadata entity(s) under which this extended metadata element may appear.

Parameters:

new­Values - the new parent entity.

getRule

public InternationalString getRule()

Specifies how the extended element relates to other existing elements and entities.

Specified by:

get­Rule in interface Extended­Element­Information

Returns:

how the extended element relates to other existing elements and entities, or null.

setRule

public void setRule(InternationalString newValue)

Sets how the extended element relates to other existing elements and entities.

Parameters:

new­Value - the new rule.

getRationale

@UML(identifier="rationale",
     obligation=OPTIONAL,
     specification=ISO_19115)
public InternationalString getRationale()

Returns the reason for creating the extended element.

Returns:

reason for creating the extended element, or null.

Since:

0.5

setRationale

public void setRationale(InternationalString newValue)

Sets the reason for creating the extended element.

Parameters:

new­Value - the new rationale.

Since:

0.5

getRationales

@Deprecated(since="1.0")
public Collection<InternationalString> getRationales()

Deprecated.

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

Description copied from interface: Extended­Element­Information

Reason for creating the extended element.

Specified by:

get­Rationales in interface Extended­Element­Information

Returns:

reason for creating the extended element.

setRationales

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

Deprecated.

As of ISO 19115:2014, replaced by set­Rationale(International­String).

Parameters:

new­Values - the new rationales.

getSources

public Collection<ResponsibleParty> getSources()

Name of the person or organization creating the extended element.

Upcoming API change — generalization
As of ISO 19115:2014, Responsible­Party is replaced by the Responsibility parent interface. This change may be applied in GeoAPI 4.0.

Specified by:

get­Sources in interface Extended­Element­Information

Returns:

name of the person or organization creating the extended element.

setSources

public void setSources(Collection<? extends ResponsibleParty> newValues)

Sets the name of the person or organization creating the extended element.

Upcoming API change — generalization
As of ISO 19115:2014, Responsible­Party is replaced by the Responsibility parent interface. This change may be applied in GeoAPI 4.0.

Parameters:

new­Values - the new sources.