Added by jgarnett, last edited by jgarnett on Mar 13, 2007  (view change)

Labels

 
(None)

Submit a Change Request to GeoAPI

We need enough information to get your change:

  • coded correctly citing appropriate specifications
  • written up in the report to the working group
  • with enough information that is is approved

Here is a quick checklist:

  1. Check change against ISO/OGC specification
  2. Email list - warn that subject is under review
    • remember to mention specification(s)
    • answer developer list questions as the arise
  3. Create jira issues for individual requests
    • We will use this to track discussion and progress
  4. Update existing interfaces
    • apply changes to trunk
    • @version javadoc tag
    • @UML annotations
  5. Create interface
    • apply changes to trunk
    • @author javadoc tag
    • @since javadoc tag
    • @UML annotations
  6. Update package.html
    • Link to relevant specifications
  7. Publish SNAPSHOT using "mvn deploy"

Optional:

  1. Fix implementations in GeoTools

The @UML annotations are used to link to the correct ISO or OGC specifications.

Prepare Working Group Report

When we are ready to prepare the report for OGC, use "svn diff" between the trunk and the 2.0 branch. It should provide the needed information, but will be long to digest and put into the document for OGC.

You can help by ensuring the following:

  Email Jira svn diff
proposed change  
affected sections  
purpose  
specific changes    
consequences of change  
consequences if not approved  

Please mention your JIRA number in your svn commit.

You can look at the following draft for examples:

Affected Sections and @UML Annotation

For * affected sections* refer to the GO specification:

If we want to change an interface that appears in a UML of the above-cited document we need the chapter or figure number.

The other source of information are the @UML annotation in the Java code.
This annotation shall link to:

  • A UML identifier from an abstract specification if available
  • Otherwise, a UML identifier from an implementation specification if available
  • Otherwise, a UML identifier from the GO specification if available
  • Otherwise, the @Extension annotation.

So if you see something like

@UML(specification=GO, identifier="foo")

You have partial information for section but you will need to hunt down the chapter/figure number.

Purpose of Change

Usually "Better alignment with ISO specification", although you will need to cite the OGC/ISO section using information from the @UML annotations.