Module org.opengis.geoapi

Package org.opengis.feature

Interface IdentifiedType

All Known Subinterfaces:

AttributeType<V>, DynamicAttributeType<V>, FeatureAssociationRole, FeatureType, Operation, PropertyType

@Classifier(METACLASS)
@UML(identifier="IdentifiedType",
     specification=ISO_19109)
public interface IdentifiedType

Identification and description information inherited by property types and feature types.

Since:

3.1

Method Summary

Modifier and Type	Method	Description
InternationalString	getDefinition()	Returns a concise definition of the element.
default InternationalString	getDescription()	Returns optional information beyond that required for concise definition of the element.
default InternationalString	getDesignation()	Returns a natural language designator for the element.
GenericName	getName()	Returns the name of this type.

Method Details

getName

@UML(identifier="name",
     obligation=OPTIONAL,
     specification=ISO_19109)
GenericName getName()

Returns the name of this type. The namespace can be either explicit (ScopedName) or implicit (LocalName). The name is optional for Operation, but mandatory for other types. For AttributeType, the name shall be unique in the FeatureType. For FeatureType, the name shall be unique in the unit processing the data.

Returns:

the type name, or null if none.

getDefinition

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

Returns a concise definition of the element.

Returns:

concise definition of the element.

getDesignation

@UML(identifier="designation",
     obligation=OPTIONAL,
     specification=ISO_19109)
default InternationalString getDesignation()

Returns a natural language designator for the element. This can be used as an alternative to the name in user interfaces.

Returns:

natural language designator for the element, or null if none.

getDescription

@UML(identifier="description",
     obligation=OPTIONAL,
     specification=ISO_19109)
default InternationalString getDescription()

Returns optional information beyond that required for concise definition of the element. The description may assist in understanding the element scope and application.

Returns:

information beyond that required for concise definition of the element, or null if none.