Changeset 9370 in josm for trunk/src/org

Timestamp:

2016-01-09T22:33:40+01:00 (9 years ago)

Author:

bastiK

Message:

unit test & javadoc

File:

• trunk/src/org/openstreetmap/josm/data/projection/Projections.java (modified) (8 diffs)

trunk/src/org/openstreetmap/josm/data/projection/Projections.java

@@ -44 +44 @@
 
 /**
- * Class to handle projections
+ * Class to manage projections.
  *
+ * Use this class to query available projection or register new projections
+ * from a plugin.
  */
 public final class Projections {
@@ -157 +159 @@
     }
 
+    /**
+     * Convert from lat/lon to easting/northing using the current projection.
+     *
+     * @param ll the geographical point to convert (in WGS84 lat/lon)
+     * @return the corresponding east/north coordinates
+     */
     public static EastNorth project(LatLon ll) {
         if (ll == null) return null;
@@ -162 +170 @@
     }
 
+    /**
+     * Convert from easting/norting to lat/lon using the current projection.
+     *
+     * @param en the geographical point to convert (in projected coordinates)
+     * @return the corresponding lat/lon (WGS84)
+     */
     public static LatLon inverseProject(EastNorth en) {
         if (en == null) return null;
@@ -184 +198 @@
     }
 
+    /**
+     * Get a base projection by id.
+     *
+     * @param id the id, for example "lonlat" or "tmerc"
+     * @return the corresponding base projection if the id is known, null otherwise
+     */
     public static Proj getBaseProjection(String id) {
         ProjFactory fac = projs.get(id);
@@ -190 +210 @@
     }
 
+    /**
+     * Get an ellipsoid by id.
+     *
+     * @param id the id, for example "bessel" or "WGS84"
+     * @return the corresponding ellipsoid if the id is known, null otherwise
+     */
     public static Ellipsoid getEllipsoid(String id) {
         return ellipsoids.get(id);
     }
 
+    /**
+     * Get a geodetic datum by id.
+     *
+     * @param id the id, for example "potsdam" or "WGS84"
+     * @return the corresponding datum if the id is known, null otherwise
+     */
     public static Datum getDatum(String id) {
         return datums.get(id);
     }
 
+    /**
+     * Get a NTV2 grid database by id.
+     * @param id the id
+     * @return the corresponding NTV2 grid if the id is known, null otherwise
+     */
     public static NTV2GridShiftFileWrapper getNTV2Grid(String id) {
         return nadgrids.get(id);
@@ -203 +240 @@
 
     /**
-     * Get the projection definition string for the given id.
-     * @param id the id
+     * Get the projection definition string for the given code.
+     * @param code the code
      * @return the string that can be processed by #{link CustomProjection}.
-     * Null, if the id isn't supported.
-     */
-    public static String getInit(String id) {
-        ProjectionDefinition pd = inits.get(id.toUpperCase(Locale.ENGLISH));
+     * Null, if the code isn't supported.
+     */
+    public static String getInit(String code) {
+        ProjectionDefinition pd = inits.get(code.toUpperCase(Locale.ENGLISH));
         if (pd == null) return null;
         return pd.definition;
@@ -260 +297 @@
     }
 
+    /**
+     * Get a projection by code.
+     * @param code the code, e.g. "EPSG:2026"
+     * @return the corresponding projection, if the code is known, null otherwise
+     */
     public static Projection getProjectionByCode(String code) {
         Projection proj = projectionsByCode_cache.get(code);
@@ -293 +335 @@
     }
 
+    /**
+     * Get a list of ids of all registered base projections.
+     *
+     * @return all registered base projection ids
+     * @see #getBaseProjection(java.lang.String)
+     */
+    public static Collection<String> getAllBaseProjectionIds() {
+        return projs.keySet();
+    }
+
     private static String listKeys(Map<String, ?> map) {
         List<String> keys = new ArrayList<>(map.keySet());