GeoAPI
  1. GeoAPI
  2. GEO-53

Feature, filter and SLD packages need @UML tags

    Details

    • Type: Task Task
    • Status: Closed Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 2.0
    • Fix Version/s: 2.0
    • Component/s: feature
    • Labels:
      None
    • Number of attachments :
      0

      Description

      Feature, filter and SLD packages need editorial work before we do any API change and/or before we bundle them in a GeoAPI 1.1 release:

      • The class javadoc should contains an @version tag with the
        specification URL and version number. Example from CRS:

      @author ISO 19111
      @author <A HREF="http://www.opengis.org">OpenGIS® consortium</A>
      @version <A HREF="http://www.opengis.org/docs/03-073r1.zip">Abstract specification 2.0</A>

      • For each interfaces and each methods in org.opengis.feature, there is a choice:
      • If the interface/method is derived from an OpenGIS specification,
        add a @UML annotation (commented out, but must still be present).
        E.g. from CRS:

      /// @UML (identifier="usesDatum", obligation=MANDATORY)
      Datum getDatum();

      • Otherwise, if the interface/method is a GeoAPI addition, do not put any @UML annotation.

      @UML annotations are an important part of GeoAPI. They are essential for helping us to track GeoAPI compliance to OGC standards. They are automatically parsed at building time, and used for automatic generation of the following page:

      http://geoapi.sourceforge.net/snapshot/javadoc/org/opengis/doc-files/departures-list.html

      Note that all feature, filter and sld interfaces are currently marked as non-standard because they don"t yet have @UML annotations.

        Activity

        Hide
        Martin Desruisseaux added a comment -

        Actually added @XmlElement tags instead, since those API where derived from XML schema.

        Show
        Martin Desruisseaux added a comment - Actually added @XmlElement tags instead, since those API where derived from XML schema.
        Hide
        Martin Desruisseaux added a comment -

        The task was straightforward for filter, layer and SLD.
        Feature was more difficult. It doesn't have a lot of obvious matching, but I added the @XmlSchema that I have found.

        Show
        Martin Desruisseaux added a comment - The task was straightforward for filter, layer and SLD. Feature was more difficult. It doesn't have a lot of obvious matching, but I added the @XmlSchema that I have found.

          People

          • Assignee:
            Martin Desruisseaux
            Reporter:
            Martin Desruisseaux
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Time Tracking

              Estimated:
              Original Estimate - 3 hours
              3h
              Remaining:
              Remaining Estimate - 3 hours
              3h
              Logged:
              Time Spent - Not Specified
              Not Specified