Module org.opengis.geoapi
Package org.opengis.annotation

Annotation Interface UML

@Documented @Retention(RUNTIME) @Target({TYPE,FIELD,METHOD}) public @interface UML
An annotation mapping each interface, methods or fields to the UML identifier where they come from.
Since:
2.0

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    identifier
    The UML identifier for the annotated interface, method or code list element.
    Specification
    specification
    The specification where this UML come from.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Obligation
    obligation
    The obligation declared in the UML.
    short
    version
    The version of the specification where this UML come from, or 0 for the default version.

  • Element Details

    • identifier

      String identifier
      The UML identifier for the annotated interface, method or code list element. Scripts can use this identifier in order to maps a GeoAPI method to the UML entity where it come from.
      Returns:
      the UML identifier used in the standard.

    • obligation

      Obligation obligation
      The obligation declared in the UML. This metadata can be queried in order to determine if a null value is allowed for the annotated method or not. If the obligation is Obligation.MANDATORY, then null value are not allowed.
      Returns:
      the obligation declared in the standard.
      Default:
      MANDATORY

    • specification

      Specification specification
      The specification where this UML come from.
      Returns:
      the originating specification.

    • version

      short version
      The version of the specification where this UML come from, or 0 for the default version. The valid version numbers are listed in Specification enumeration constants.

      When older standard versions are used:

      The vast majority of non-deprecated GeoAPI methods leave UML.version() to its default value, meaning that the Specification default version (usually latest OGC/ISO version) is used. However, there is a few exceptions when an older version of an OGC or ISO standard is preferred. Examples:
      • ISO 19115:2003 defined PT_Locale in a way closer to the java.util.Locale model than the newer ISO 19115:2014.
      • An ISO 19111 revision by OGC defined geographic and geocentric CRS in a more type-safe way than ISO 19111:2007. The later model requires C/C++ union construct for type-safety, which does not exist in the Java language.
      Returns:
      the specification version, or 0 for the default (usually latest) specification.
      Since:
      3.1
      See Also:
      Default:
      0