org.geotools.metadata.iso

Class ExtendedElementInformationImpl

Object

AbstractMetadata

ModifiableMetadata

MetadataEntity

ExtendedElementInformationImpl

All Implemented Interfaces:

Serializable, Cloneable, ExtendedElementInformation

public class ExtendedElementInformationImpl
extends MetadataEntity
implements ExtendedElementInformation

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

Since:

2.1

Author:

Martin Desruisseaux (IRD), Touraïvane

See Also:

Serialized Form

Field Summary

Fields inherited from class AbstractMetadata

LOGGER

Constructor Summary

Constructors

Constructor and Description
ExtendedElementInformationImpl() Construct an initially empty extended element information.
ExtendedElementInformationImpl(ExtendedElementInformation source) Constructs a metadata entity initialized with the values from the specified metadata.
ExtendedElementInformationImpl(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

Modifier and Type	Method and Description
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) Set the condition under which the extended element is mandatory.
void	setDataType(Datatype newValue) Set the code which identifies the kind of value provided in the extended element.
void	setDefinition(InternationalString newValue) Set the definition of the extended element.
void	setDomainCode(Integer newValue) Set a three digit code assigned to the extended element.
void	setDomainValue(InternationalString newValue) Set the valid values that can be assigned to the extended element.
void	setMaximumOccurrence(Integer newValue) Set the maximum occurrence of the extended element.
void	setName(String newValue) Set the name of the extended metadata element.
void	setObligation(Obligation newValue) Set the obligation of the extended element.
void	setParentEntity(Collection<? extends String> newValues) Set the name of the metadata entity(s) under which this extended metadata element may appear.
void	setRationales(Collection<? extends InternationalString> newValues) Set the reason for creating the extended element.
void	setRule(InternationalString newValue) Set how the extended element relates to other existing elements and entities.
void	setShortName(String newValue) Set a short form suitable for use in an implementation method such as XML or SGML.
void	setSources(Collection<? extends ResponsibleParty> newValues) Set the name of the person or organization creating the extended element.

Methods inherited from class MetadataEntity

ensureNonNull, getStandard

Methods inherited from class ModifiableMetadata

checkWritePermission, clone, copyCollection, copyList, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, unmodifiable

Methods inherited from class AbstractMetadata

asMap, asTree, equals, getInterface, hashCode, toString

Methods inherited from class Object

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

Constructor Detail

ExtendedElementInformationImpl

public ExtendedElementInformationImpl()

Construct an initially empty extended element information.

ExtendedElementInformationImpl

public ExtendedElementInformationImpl(ExtendedElementInformation source)

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

Since:

2.4

ExtendedElementInformationImpl

public ExtendedElementInformationImpl(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 Detail

getName

public String getName()

Name of the extended metadata element.

Specified by:

getName in interface ExtendedElementInformation

Returns:

Name of the extended metadata element.

setName

public void setName(String newValue)

Set the name of the extended metadata element.

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

Returns:

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

setShortName

public void setShortName(String newValue)

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

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

Returns:

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

setDomainCode

public void setDomainCode(Integer newValue)

Set a three digit code assigned to the extended element.

getDefinition

public InternationalString getDefinition()

Definition of the extended element.

Specified by:

getDefinition in interface ExtendedElementInformation

Returns:

Definition of the extended element.

setDefinition

public void setDefinition(InternationalString newValue)

Set the definition of the extended element.

getObligation

public Obligation getObligation()

Obligation of the extended element.

Specified by:

getObligation in interface ExtendedElementInformation

Returns:

Obligation of the extended element, or null.

setObligation

public void setObligation(Obligation newValue)

Set the obligation of the extended element.

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

Returns:

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

setCondition

public void setCondition(InternationalString newValue)

Set the condition under which the extended element is mandatory.

getDataType

public Datatype getDataType()

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

Specified by:

getDataType in interface ExtendedElementInformation

Returns:

The kind of value provided in the extended element.

setDataType

public void setDataType(Datatype newValue)

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

getMaximumOccurrence

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

Returns:

Maximum occurrence of the extended element, or null.

setMaximumOccurrence

public void setMaximumOccurrence(Integer newValue)

Set the maximum occurrence of the extended element.

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

Returns:

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

setDomainValue

public void setDomainValue(InternationalString newValue)

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

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

Returns:

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

setParentEntity

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

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

getRule

public InternationalString getRule()

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

Specified by:

getRule in interface ExtendedElementInformation

Returns:

How the extended element relates to other existing elements and entities.

setRule

public void setRule(InternationalString newValue)

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

getRationales

public Collection<InternationalString> getRationales()

Reason for creating the extended element.

Specified by:

getRationales in interface ExtendedElementInformation

Returns:

Reason for creating the extended element.

setRationales

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

Set the reason for creating the extended element.

getSources

public Collection<ResponsibleParty> getSources()

Name of the person or organization creating the extended element.

Specified by:

getSources in interface ExtendedElementInformation

Returns:

Name of the person or organization creating the extended element.

setSources

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

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