[SIS-185] Define the commited API for Shapefile

• Type: Task
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: Shapefile
• Assignee: Johann Sorel
• Reporter: Martin Desruisseaux
• Created: 18/Dec/14 04:02
• Updated: 05/Dec/23 16:00

Description

We should define the first elements of what would be the committed API for Shapefile. The intend of this task is not to define the full API neither to change implementation details that are not visible through the API. The intend is only to reduce the size of the public API to elements that, we think, have good chances to stay there.

This task is targeted for completion before SIS 0.5 release. The intend is to give some guarantees to Apache SIS 0.5 users that their code is likely to compile and run with Apache SIS 0.6. To achieve this goal, the proposal is to hide the API elements which are likely to change, for preventing users to depend on it. Those API elements can be hidden either by declaring them package-privated, or by moving them in any org.apache.sis.internal sub-package, depending on which approach is the less disruptive for the code.

Issue Links

• is depended upon by: SIS-100 Implement a ShapeFile data store

Sub-Tasks

• Set Shapefile as a subclass of DataStore: Resolved
• Reduce visibility of Shapefile fields: Resolved
• Hide FieldDescriptor (a DBase3 internal format structure): Resolved
• InvalidDbaseFileFormatException should extend DataStoreException: Resolved