Module org.opengis.geoapi

Package org.opengis.metadata

Interface ExtendedElementInformation

@UML(identifier="MD_ExtendedElementInformation",
     specification=ISO_19115)
public interface 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.

Since:

2.0

Method Summary

Modifier and Type	Method	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.
default Integer	getDomainCode()	Deprecated. Removed as of ISO 19115:2014.
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.
default InternationalString	getRationale()	Reason for creating the extended element.
default Collection<? extends InternationalString>	getRationales()	Deprecated. As of ISO 19115:2014, replaced by getRationale().
InternationalString	getRule()	Specifies how the extended element relates to other existing elements and entities.
default String	getShortName()	Deprecated. Removed as of ISO 19115:2014.
Collection<? extends ResponsibleParty>	getSources()	Name of the person or organization creating the extended element.

Method Details

getName

@UML(identifier="name",
     obligation=MANDATORY,
     specification=ISO_19115)
String getName()

Name of the extended metadata element.

Returns:

name of the extended metadata element.

Departure from OGC/ISO standard for historical reason

This property has been kept conform to ISO 19115:2003 for simplicity. The 2014 revision defines two mutually exclusive names depending on the data type: "conceptName" for ENUMERATION, CODE_LIST or CODE_LIST_ELEMENT, and "name" for all other data types. GeoAPI keeps the "name" property for all data types and let developers inspect the "dataType" property if needed.

getShortName

@Deprecated(since="3.1")
@UML(identifier="shortName",
     obligation=CONDITIONAL,
     specification=ISO_19115,
     version=2003)
default String getShortName()

Deprecated.

Removed as of ISO 19115:2014.

Short form suitable for use in an implementation method such as XML or SGML. Returns null if the data type is code list element, in which case getDomainCode() may be used instead.

Returns:

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

Condition:

The data type is not CODE_LIST_ELEMENT.

getDomainCode

@Deprecated(since="3.1")
@UML(identifier="domainCode",
     obligation=CONDITIONAL,
     specification=ISO_19115,
     version=2003)
default 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, otherwise getShortName() may be used instead.

Returns:

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

Condition:

The data type is CODE_LIST_ELEMENT.

getDefinition

@UML(identifier="definition",
     obligation=MANDATORY,
     specification=ISO_19115)
InternationalString getDefinition()

Definition of the extended element.

Returns:

definition of the extended element.

getObligation

@UML(identifier="obligation",
     obligation=CONDITIONAL,
     specification=ISO_19115)
Obligation getObligation()

Obligation of the extended element.

Upcoming API change — type change
According ISO 19115, Obligation shall be an enumeration, not a code list. Such enumeration already exists in the org.opengis.annotation package. Consequently the org.opengis.metadata.Obligation return type may be replaced by org.opengis.annotation.Obligation in GeoAPI 4.0. See GEO-199 for more information.

Returns:

obligation of the extended element, or null.

Condition:

The data type is not ENUMERATION, CODE_LIST or CODE_LIST_ELEMENT.

getCondition

@UML(identifier="condition",
     obligation=CONDITIONAL,
     specification=ISO_19115)
InternationalString getCondition()

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

Returns:

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

Condition:

The Obligation is CONDITIONAL.

getDataType

@UML(identifier="dataType",
     obligation=MANDATORY,
     specification=ISO_19115)
Datatype getDataType()

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

Returns:

the kind of value provided in the extended element.

getMaximumOccurrence

@UML(identifier="maximumOccurrence",
     obligation=CONDITIONAL,
     specification=ISO_19115)
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.

Returns:

maximum occurrence of the extended element, or null.

Condition:

The data type is not ENUMERATION, CODE_LIST or CODE_LIST_ELEMENT.

getDomainValue

@UML(identifier="domainValue",
     obligation=CONDITIONAL,
     specification=ISO_19115)
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.

Returns:

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

Condition:

The data type is not ENUMERATION, CODE_LIST or CODE_LIST_ELEMENT.

getParentEntity

@UML(identifier="parentEntity",
     obligation=MANDATORY,
     specification=ISO_19115)
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).

Returns:

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

getRule

@UML(identifier="rule",
     obligation=MANDATORY,
     specification=ISO_19115)
InternationalString getRule()

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

Returns:

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

getRationale

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

Reason for creating the extended element.

Returns:

reason for creating the extended element.

Since:

3.1

getRationales

@Deprecated(since="3.1")
default Collection<? extends InternationalString> getRationales()

Deprecated.

As of ISO 19115:2014, replaced by getRationale().

Returns:

reason for creating the extended element.

getSources

@UML(identifier="source",
     obligation=MANDATORY,
     specification=ISO_19115,
     version=2003)
Collection<? extends ResponsibleParty> getSources()

Name of the person or organization creating the extended element.

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

Returns:

name of the person or organization creating the extended element.