Description

Describe your proposal here, if needed you can provide background information, reference OGC documents, include class diagrams to show what you are simplifying, etc..

Try and provide context if you have a deadline, customer, and any additional information (if you have a design document you can attach it to the page as a PDF).

Status

This proposal is under construction.

Voting has not started yet:

...

Reading the Java 7 planned try-with-resource syntax I am convinced that supporting the Closable interface is necessary change for GeoTools 9.x.

Reading: 

• The try-with-resources Statement (Java Tutorials)
• Eclipse Juno try-with-resources statement

Status

This proposal is shaping up, ask question on the email list or vote below:

• Andrea Aime +1
• Ben Caradoc-Davies
• Christian Mueller +1
• Ian Turton +1
• Justin Deoliveira +1
• Jody Garnett +1
• Simone Giannecchini

Tasks

This section is used to make sure your proposal is complete (did you remember documentation?) and has enough paid or volunteer time lined up to be a success

1. API changed based on BEFORE / AFTER
2. Update default implementation
3. Update wiki (both module matrix and upgrade to to 2.5 pages) |
4. Remove deprecated code from GeoTools project
5. Update the user guide
6. Update or provided sample code in demo
7. review user documentation

1.  Coordinate API Change (above patches should be tested / applied together)
2. Implement Closable
   
   •  FeatureIterator
   •  FeatureReader
   •  FeatureWriter
3.  A lot of this work got rolled into the FeatureCollection clean up
4. Warn / Patch downstream applications (Combined with FeatureCollection cleanup)
   
   1.  Patch for GeoServer
   2.  Patch for uDig (patch ready held up waiting for 1.3.3 release)
5. Check the code examples in user guide
   
   •  Feature Collection try-with-resource code example
   •  Geometry CRS Tutorial
   •  Query Tutorial

API Changes

FeatureIterator

...

import java.lang.Closable;
public interface FeatureWriter<T extends FeatureType, F extends Feature> extends Closable {
    T getFeatureType();
    F next() throws IOException;
    void remove() throws IOException;
    void write() throws IOException;
    boolean hasNext() throws IOException;
    void close() throws IOException;
}

Documentation Changes

list the pages effected by this proposal

• gt-opengis filter api update to reflect api change
• gt-main filter examples updated to reflect api change
• upgrade instructions
• Module Matrix page