Geomark Web Service Client API

Construct a new Geomark client that is not connected to a specific Geomark server. This client can only be used to get the geomark info, or geometry using full geomark URL's. It cannot be used to add geomarks or manage groups.

Construct a new Geomark client that is connected to a specific Geomark web service (e.g. https://apps.gov.bc.ca/pub/geomark). This client can also get the geomark info, or download geomark geometry using full geomark URL's from other servers.

Construct a new new geomark from an InputStream containing the geometry using the Create Geomark REST API.

The extended parameters to the method are passed in using a Java (map). See the Create Geomark Copy REST API for the list of supported parameters.

The following code fragment shows an example of using the API.

 String baseUrl = "https://apps.gov.bc.ca/pub/geomark";
 GeomarkClient client = new GeomarkClient(baseUrl);

 InputStream geometry = new FileInputStream("...");

 Map<String, Object> parameters = new HashMap<String, Object>();
 parameters.put(GeomarkClient.SRID, 4326);
 parameters.put(GeomarkClient.FORMAT, "wkt");

 String geomarkUrl = client.addGeomark(geometry, parameters);
 System.out.println(geomarkUrl);
 

Construct a new new geomark from a string containg a KML, GML, or WKT geometry using the Create Geomark REST API.

The extended parameters to the method are passed in using a Java (map). See the Create Geomark Copy REST API for the list of supported parameters.

The following code fragment shows an example of using the API.

 String baseUrl = "https://apps.gov.bc.ca/pub/geomark";
 GeomarkClient client = new GeomarkClient(baseUrl);

 String geometry = "POLYGON((-112 47,-144 47,-144 60,-112 60,-112 47))";

 Map<String, Object> parameters = new HashMap<String, Object>();
 parameters.put(GeomarkClient.SRID, 4326);
 parameters.put(GeomarkClient.FORMAT, "wkt");

 String geomarkUrl = client.addGeomark(geometry, parameters);
 System.out.println(geomarkUrl);
 

Add the geomarks to the geomark group.

The following code fragment shows an example of using the API.

 String baseUrl = "https://apps.gov.bc.ca/pub/geomark";
 GeomarkClient client = new GeomarkClient(baseUrl);
 String geomarkGroupId = "...";
 String geomarkGroupSecretKey = "...";

 Map<String, Object> response = client.addGeomarksToGroup(geomarkGroupId,
   geomarkGroupSecretKey, "gm-abcdefghijklmnopqrstuv0bcislands");
 System.out.println(response);
 

The method returns a map with the following attributes.

Add the geomarks to the geomark group.

The following code fragment shows an example of using the API.

 String baseUrl = "https://apps.gov.bc.ca/pub/geomark";
 GeomarkClient client = new GeomarkClient(baseUrl);
 String geomarkGroupId = "...";
 String geomarkGroupSecretKey = "...";

 Map<String, Object> response = client.addGeomarksToGroup(geomarkGroupId,
   geomarkGroupSecretKey, "gm-abcdefghijklmnopqrstuv0bcislands");
 System.out.println(response);
 

The method returns a map with the following attributes.

Construct a new new geomark by copying the geometries from one or more existing geomarks using the Create Geomark Copy REST API.

The extended parameters to the method are passed in using a Java (map). See the Create Geomark Copy REST API for the list of supported parameters.

The following code fragment shows an example of using the API.

 String baseUrl = "https://apps.gov.bc.ca/pub/geomark";
 GeomarkClient client = new GeomarkClient(baseUrl);
 Map<String, Object> parameters = new HashMap<String, Object>();
 parameter.put(GeomarkClient.BUFFER_METRES, 10);

 List<String> geomarks = Arrays.asList("gm-abcdefghijklmnopqrstuv0bcislands");

 String geomarkUrl = client.copyGeomark(parameters, geomarks);
 

Construct a new new geomark by copying the geometries from one or more existing geomarks using the Create Geomark Copy REST API.

The extended parameters to the method are passed in using a Java (map). See the Create Geomark Copy REST API for the list of supported parameters.

The following code fragment shows an example of using the API.

 String baseUrl = "https://apps.gov.bc.ca/pub/geomark";
 GeomarkClient client = new GeomarkClient(baseUrl);
 Map<String, Object> parameters = new HashMap<String, Object>();
 parameter.put(GeomarkClient.BUFFER_METRES, 10);

 String geomarkUrl = client.copyGeomark(parameters,
   "gm-abcdefghijklmnopqrstuvwxyz0000bc");
 

Delete the geomarks from the geomark group.The method does not check if the geomark was a member of the group before deleting, this allows the method to be called multiple times without failure.

The following code fragment shows an example of using the API.

 String baseUrl = "https://apps.gov.bc.ca/pub/geomark";
 GeomarkClient client = new GeomarkClient(baseUrl);
 String geomarkGroupId = "...";
 String geomarkGroupSecretKey = "...";

 Map<String, Object> response = client.deleteGeomarksFromGroup(geomarkGroupId,
   geomarkGroupSecretKey, 90, "gm-abcdefghijklmnopqrstuv0bcislands");
 System.out.println(response);
 

The method returns a map with the following attributes.

Delete the geomarks from the geomark group.The method does not check if the geomark was a member of the group before deleting, this allows the method to be called multiple times without failure.

The following code fragment shows an example of using the API.

 String baseUrl = "https://apps.gov.bc.ca/pub/geomark";
 GeomarkClient client = new GeomarkClient(baseUrl);
 String geomarkGroupId = "...";
 String geomarkGroupSecretKey = "...";

 Map<String, Object> response = client.deleteGeomarksFromGroup(geomarkGroupId,
   geomarkGroupSecretKey, 90, "gm-abcdefghijklmnopqrstuv0bcislands");
 System.out.println(response);
 

The method returns a map with the following attributes.

Get an InputStream to the geomark bounding box using the Get Geomark Bounding Box REST API.

The caller must close the stream when the resource is downloaded. Use a try/finally block to ensure the stream is closed.

The following code fragment shows an example of using the API.

 String baseUrl = "https://apps.gov.bc.ca/pub/geomark";
 GeomarkClient client = new GeomarkClient(baseUrl);

 String geomarkId = "gm-abcdefghijklmnopqrstuv0bcislands";

 InputStream in = client.getGeomarkBoundingBoxStream(geomarkId, "kml", 4326);
 try {
   // Read the stream
 } finally {
   in.close();
 }
 

Get the URL to the geomark bounding box using the Get Geomark Bounding Box REST API.

The following code fragment shows an example of using the API.

 String baseUrl = "https://apps.gov.bc.ca/pub/geomark";
 GeomarkClient client = new GeomarkClient(baseUrl);

 String geomarkId = "gm-abcdefghijklmnopqrstuv0bcislands";

 String geomarkUrl = client.getGeomarkBoundingBoxUrl(geomarkId, "kml", 4326);
 System.out.println(geomarkUrl);
 

Get an InputStream to the geomark feature using the Get Geomark Feature REST API.

The caller must close the stream when the resource is downloaded. Use a try/finally block to ensure the stream is closed.

The following code fragment shows an example of using the API.

 String baseUrl = "https://apps.gov.bc.ca/pub/geomark";
 GeomarkClient client = new GeomarkClient(baseUrl);

 String geomarkId = "gm-abcdefghijklmnopqrstuv0bcislands";

 InputStream in = client.getGeomarkFeatureStream(geomarkId, "kml", 4326);
 try {
   // Read the stream
 } finally {
   in.close();
 }
 

Get the URL to the geomark feature using the Get Geomark Feature REST API.

The following code fragment shows an example of using the API.

 String baseUrl = "https://apps.gov.bc.ca/pub/geomark";
 GeomarkClient client = new GeomarkClient(baseUrl);

 String geomarkId = "gm-abcdefghijklmnopqrstuv0bcislands";

 String geomarkUrl = client.getGeomarkFeatureUrl(geomarkId, "kml", 4326);
 System.out.println(geomarkUrl);
 

Get a Map containing the geomark info using the Get Geomark Info REST API.

The following code fragment shows an example of using the API.

 String baseUrl = "https://apps.gov.bc.ca/pub/geomark";
 GeomarkClient client = new GeomarkClient(baseUrl);

 String geomarkId = "gm-abcdefghijklmnopqrstuv0bcislands";

 Map<String, Object> geomark = client.getGeomarkInfo(geomarkId);
 System.out.println(geomark);
 

Get an InputStream to the geomark info using the Get Geomark Info REST API.

The caller must close the stream when the resource is downloaded. Use a try/finally block to ensure the stream is closed.

The following code fragment shows an example of using the API.

 String baseUrl = "https://apps.gov.bc.ca/pub/geomark";
 GeomarkClient client = new GeomarkClient(baseUrl);

 String geomarkId = "gm-abcdefghijklmnopqrstuv0bcislands";

 InputStream in = client.getGeomarkInfoStream(geomarkId, "json");
 try {
   // Read the stream
 } finally {
   in.close();
 }
 

Get the URL to the geomark info using the Get Geomark Info REST API.

The following code fragment shows an example of using the API.

 String baseUrl = "https://apps.gov.bc.ca/pub/geomark";
 GeomarkClient client = new GeomarkClient(baseUrl);

 String geomarkId = "gm-abcdefghijklmnopqrstuv0bcislands";

 String geomarkUrl = client.getGeomarkInfoUrl(geomarkId, "json");
 System.out.println(geomarkUrl);
 

Get an InputStream to the geomark parts using the Get Geomark Parts REST API.

The caller must close the stream when the resource is downloaded. Use a try/finally block to ensure the stream is closed.

The following code fragment shows an example of using the API.

 String baseUrl = "https://apps.gov.bc.ca/pub/geomark";
 GeomarkClient client = new GeomarkClient(baseUrl);

 String geomarkId = "gm-abcdefghijklmnopqrstuv0bcislands";

 InputStream in = client.getGeomarkPartsStream(geomarkId, "kml", 4326);
 try {
   // Read the stream
 } finally {
   in.close();
 }
 

Get the URL to the geomark parts using the Get Geomark Parts REST API.

The following code fragment shows an example of using the API.

 String baseUrl = "https://apps.gov.bc.ca/pub/geomark";
 GeomarkClient client = new GeomarkClient(baseUrl);

 String geomarkId = "gm-abcdefghijklmnopqrstuv0bcislands";

 String geomarkUrl = client.getGeomarkPartsUrl(geomarkId, "kml", 4326);
 System.out.println(geomarkUrl);
 

Get an InputStream to the geomark point using the Get Geomark Point REST API.

The caller must close the stream when the resource is downloaded. Use a try/finally block to ensure the stream is closed.

The following code fragment shows an example of using the API.

 String baseUrl = "https://apps.gov.bc.ca/pub/geomark";
 GeomarkClient client = new GeomarkClient(baseUrl);

 String geomarkId = "gm-abcdefghijklmnopqrstuv0bcislands";

 InputStream in = client.getGeomarkPointStream(geomarkId, "kml", 4326);
 try {
   // Read the stream
 } finally {
   in.close();
 }
 

Get the URL to the geomark point using the Get Geomark Point REST API.

The following code fragment shows an example of using the API.

 String baseUrl = "https://apps.gov.bc.ca/pub/geomark";
 GeomarkClient client = new GeomarkClient(baseUrl);

 String geomarkId = "gm-abcdefghijklmnopqrstuv0bcislands";

 String geomarkUrl = client.getGeomarkPointUrl(geomarkId, "kml", 4326);
 System.out.println(geomarkUrl);