org.geotoolkit.metadata.iso
Class DefaultExtendedElementInformation

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              DefaultExtendedElementInformation

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, ExtendedElementInformation

@ThreadSafe
public class DefaultExtendedElementInformation
extends MetadataEntity
implements ExtendedElementInformation

New metadata element, not found in ISO 19115, which is required to describe geographic data.

Since:

2.1

Version:

3.19

Author:

Martin Desruisseaux (IRD, Geomatys), Touraïvane (IRD), Cédric Briançon (Geomatys)

See Also:

Serialized Form

Module:

metadata/geotk-metadata (download)

View source code for this class

Field Summary

Fields inherited from class MetadataEntity

identifiers

Fields inherited from class AbstractMetadata

LOGGER

Constructor Summary

DefaultExtendedElementInformation()
Construct an initially empty extended element information.

DefaultExtendedElementInformation(ExtendedElementInformation source)
Constructs a metadata entity initialized with the values from the specified metadata.

DefaultExtendedElementInformation(String name, InternationalString definition, InternationalString condition, Datatype dataType, Collection<String> parentEntity, InternationalString rule, Collection<? extends ResponsibleParty> sources)
Create an extended element information initialized to the given values.

Method Summary

static DefaultExtendedElementInformation	castOrCopy(ExtendedElementInformation object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
InternationalString	getCondition() Condition under which the extended element is mandatory.
Datatype	getDataType() Code which identifies the kind of value provided in the extended element.
InternationalString	getDefinition() Definition of the extended element.
Integer	getDomainCode() Three digit code assigned to the extended element.
InternationalString	getDomainValue() Valid values that can be assigned to the extended element.
Integer	getMaximumOccurrence() Maximum occurrence of the extended element.
String	getName() Name of the extended metadata element.
Obligation	getObligation() Obligation of the extended element.
Collection<String>	getParentEntity() Name of the metadata entity(s) under which this extended metadata element may appear.
Collection<InternationalString>	getRationales() Reason for creating the extended element.
InternationalString	getRule() Specifies how the extended element relates to other existing elements and entities.
String	getShortName() Short form suitable for use in an implementation method such as XML or SGML.
Collection<ResponsibleParty>	getSources() Name of the person or organization creating the extended element.
void	setCondition(InternationalString newValue) Sets the condition under which the extended element is mandatory.
void	setDataType(Datatype newValue) Sets the code which identifies the kind of value provided in the extended element.
void	setDefinition(InternationalString newValue) Sets the definition of the extended element.
void	setDomainCode(Integer newValue) Sets a three digit code assigned to the extended element.
void	setDomainValue(InternationalString newValue) Sets the valid values that can be assigned to the extended element.
void	setMaximumOccurrence(Integer newValue) Sets the maximum occurrence of the extended element.
void	setName(String newValue) Sets the name of the extended metadata element.
void	setObligation(Obligation newValue) Sets the obligation of the extended element.
void	setParentEntity(Collection<? extends String> newValues) Sets the name of the metadata entity(s) under which this extended metadata element may appear.
void	setRationales(Collection<? extends InternationalString> newValues) Sets the reason for creating the extended element.
void	setRule(InternationalString newValue) Sets how the extended element relates to other existing elements and entities.
void	setShortName(String newValue) Sets a short form suitable for use in an implementation method such as XML or SGML.
void	setSources(Collection<? extends ResponsibleParty> newValues) Sets the name of the person or organization creating the extended element.

Methods inherited from class MetadataEntity

getIdentifier, getIdentifierMap, getIdentifiers, getStandard

Methods inherited from class ModifiableMetadata

checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, prune, unmodifiable

Methods inherited from class AbstractMetadata

asMap, asTree, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, parse, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultExtendedElementInformation

public DefaultExtendedElementInformation()

Construct an initially empty extended element information.

DefaultExtendedElementInformation

public DefaultExtendedElementInformation(ExtendedElementInformation source)

Constructs a metadata entity initialized with the values from the specified metadata.

Parameters:

source - The metadata to copy, or null if none.

Since:

2.4

DefaultExtendedElementInformation

public DefaultExtendedElementInformation(String name,
                                         InternationalString definition,
                                         InternationalString condition,
                                         Datatype dataType,
                                         Collection<String> parentEntity,
                                         InternationalString rule,
                                         Collection<? extends ResponsibleParty> sources)

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.

dataType - The code which identifies the kind of value provided in the extended element.

parentEntity - 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.

sources - The name of the person or organization creating the extended element.

Method Detail

castOrCopy

public static DefaultExtendedElementInformation castOrCopy(ExtendedElementInformation object)

Returns a Geotk metadata implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object, using a shallow copy operation (i.e. attributes are not cloned).

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

3.18

getName

public String getName()

Name of the extended metadata element.

Specified by:

getName in interface ExtendedElementInformation

setName

public void setName(String newValue)

Sets the name of the extended metadata element.

Parameters:

newValue - The new name.

getShortName

public String getShortName()

Short form suitable for use in an implementation method such as XML or SGML. NOTE: other methods may be used. Returns null if the data type is code list element.

Specified by:

getShortName in interface ExtendedElementInformation

setShortName

public void setShortName(String newValue)

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

Parameters:

newValue - The new short name.

getDomainCode

public Integer getDomainCode()

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

Specified by:

getDomainCode in interface ExtendedElementInformation

setDomainCode

public void setDomainCode(Integer newValue)

Sets a three digit code assigned to the extended element.

Parameters:

newValue - The new domain code.

getDefinition

public InternationalString getDefinition()

Definition of the extended element.

Specified by:

getDefinition in interface ExtendedElementInformation

setDefinition

public void setDefinition(InternationalString newValue)

Sets the definition of the extended element.

Parameters:

newValue - The new definition.

getObligation

public Obligation getObligation()

Obligation of the extended element.

Specified by:

getObligation in interface ExtendedElementInformation

setObligation

public void setObligation(Obligation newValue)

Sets the obligation of the extended element.

Parameters:

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

getCondition in interface ExtendedElementInformation

setCondition

public void setCondition(InternationalString newValue)

Sets the condition under which the extended element is mandatory.

Parameters:

newValue - The new condition.

getDataType

public Datatype getDataType()

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

Specified by:

getDataType in interface ExtendedElementInformation

setDataType

public void setDataType(Datatype newValue)

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

Parameters:

newValue - The new data type.

getMaximumOccurrence

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

Maximum occurrence of 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:

getMaximumOccurrence in interface ExtendedElementInformation

setMaximumOccurrence

public void setMaximumOccurrence(Integer newValue)

Sets the maximum occurrence of the extended element.

Parameters:

newValue - The new maximum occurrence.

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:

getDomainValue in interface ExtendedElementInformation

setDomainValue

public void setDomainValue(InternationalString newValue)

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

Parameters:

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

getParentEntity in interface ExtendedElementInformation

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:

newValues - The new parent entity.

getRule

public InternationalString getRule()

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

Specified by:

getRule in interface ExtendedElementInformation

setRule

public void setRule(InternationalString newValue)

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

Parameters:

newValue - The new rule.

getRationales

public Collection<InternationalString> getRationales()

Reason for creating the extended element.

Specified by:

getRationales in interface ExtendedElementInformation

setRationales

public void setRationales(Collection<? extends InternationalString> newValues)

Sets the reason for creating the extended element.

Parameters:

newValues - The new rationales.

getSources

public Collection<ResponsibleParty> getSources()

Name of the person or organization creating the extended element.

Specified by:

getSources in interface ExtendedElementInformation

setSources

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

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

Parameters:

newValues - The new sources.