/*
* Copyright (c) 1998 - 2012. University Corporation for Atmospheric Research/Unidata
* Portions of this software were developed by the Unidata Program at the
* University Corporation for Atmospheric Research.
*
* Access and use of this software shall impose the following obligations
* and understandings on the user. The user is granted the right, without
* any fee or cost, to use, copy, modify, alter, enhance and distribute
* this software, and any derivative works thereof, and its supporting
* documentation for any purpose whatsoever, provided that this entire
* notice appears in all copies of the software, derivative works and
* supporting documentation. Further, UCAR requests that the user credit
* UCAR/Unidata in any publications that result from the use of this
* software or in any product that includes this software. The names UCAR
* and/or Unidata, however, may not be used in any advertising or publicity
* to endorse or promote any products or commercial entity unless specific
* written permission is obtained from UCAR/Unidata. The user also
* understands that UCAR/Unidata is not obligated to provide the user with
* any support, consulting, training or assistance of any kind with regard
* to the use, operation and performance of this software nor to provide
* the user with any updates, revisions, new versions or "bug fixes."
*
* THIS SOFTWARE IS PROVIDED BY UCAR/UNIDATA "AS IS" AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL UCAR/UNIDATA BE LIABLE FOR ANY SPECIAL,
* INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
* FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
* NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
* WITH THE ACCESS, USE OR PERFORMANCE OF THIS SOFTWARE.
*/
package ucar.nc2.stream;
import org.jdom2.Attribute;
import org.jdom2.Document;
import org.jdom2.Element;
import org.jdom2.JDOMException;
import org.jdom2.input.SAXBuilder;
import org.jdom2.input.sax.XMLReaders;
import org.jdom2.output.XMLOutputter;
import ucar.nc2.VariableSimpleIF;
import ucar.nc2.constants.FeatureType;
import ucar.nc2.dataset.NetcdfDataset;
import ucar.nc2.dt.grid.GridDataset;
import ucar.nc2.ft.FeatureCollection;
import ucar.nc2.ft.FeatureDataset;
import ucar.nc2.ft.FeatureDatasetPoint;
import ucar.nc2.ft.point.remote.PointDatasetRemote;
import ucar.nc2.ft.point.writer.FeatureDatasetPointXML;
import ucar.nc2.time.CalendarDateRange;
import ucar.nc2.units.DateUnit;
import ucar.unidata.geoloc.LatLonRect;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
/**
* Factory for FeatureDataset using CdmrRemote protocol. GRID, POINT, STATION so far
*
* @author caron
* @since May 19, 2009
*/
public class CdmrFeatureDataset {
static public final String SCHEME = "cdmrFeature:";
static private boolean debug = false;
static private boolean showXML = false;
static public FeatureDataset factory(FeatureType wantFeatureType, String endpoint) throws IOException {
if (endpoint.startsWith(SCHEME))
endpoint = endpoint.substring(SCHEME.length());
Document doc = getCapabilities(endpoint);
Element root = doc.getRootElement();
Element elem = root.getChild("featureDataset");
String uri = elem.getAttribute("url").getValue();
// Often, CdmRemoteController won't be able to figure out the FeatureType of a dataset and as a result,
// the capabilites document it returns won't contain an /cdmRemoteCapabilities/featureDataset/@type attribute.
Attribute typeAttrib = elem.getAttribute("type"); // Could be null if attribute doesn't exist.
// If the "type" attribute exists, use it; otherwise use wantFeatureType.
FeatureType ft = (typeAttrib != null) ? FeatureType.getType(typeAttrib.getValue()) : wantFeatureType;
if (debug) System.out.printf("CdmrFeatureDataset endpoint %s%n ftype= %s url=%s%n", endpoint, ft, uri);
if (ft == null || ft == FeatureType.NONE || ft == FeatureType.GRID) {
CdmRemote ncremote = new CdmRemote(uri);
NetcdfDataset ncd = new NetcdfDataset(ncremote, null);
return new GridDataset(ncd);
} else {
List<VariableSimpleIF> dataVars = FeatureDatasetPointXML.getDataVariables(doc);
LatLonRect bb = FeatureDatasetPointXML.getSpatialExtent(doc);
CalendarDateRange dr = FeatureDatasetPointXML.getTimeSpan(doc);
DateUnit timeUnit = FeatureDatasetPointXML.getTimeUnit(doc);
String altUnits = FeatureDatasetPointXML.getAltUnits(doc);
return new PointDatasetRemote(ft, uri, timeUnit, altUnits, dataVars, bb, dr);
}
}
static private org.jdom2.Document getCapabilities(String endpoint) throws IOException {
try (InputStream in = CdmRemote.sendQuery(endpoint, "req=capabilities")) {
SAXBuilder builder = new SAXBuilder(XMLReaders.NONVALIDATING);
org.jdom2.Document doc = builder.build(in);
if (showXML) {
System.out.printf("*** endpoint = %s %n", endpoint);
XMLOutputter xmlOut = new XMLOutputter();
System.out.printf("*** CdmrFeatureDataset/showParsedXML = %n %s %n", xmlOut.outputString(doc));
}
return doc;
} catch (JDOMException e) {
throw new IOException(e);
}
}
public static void main(String args[]) throws IOException {
String endpoint = "http://localhost:8080/thredds/cdmrfeature/idd/metar/ncdecodedLocalHome";
FeatureDatasetPoint fd = (FeatureDatasetPoint) CdmrFeatureDataset.factory(FeatureType.ANY, endpoint);
FeatureCollection fc = fd.getPointFeatureCollectionList().get(0);
System.out.printf("Result= %s %n %s %n", fd, fc);
/* StationTimeSeriesFeatureCollection sfc = (StationTimeSeriesFeatureCollection) fc;
PointFeatureIterator pfIter = sfc.get(-1);
try {
while (pfIter.hasNext()) {
PointFeature pf = pfIter.next();
System.out.println("pf= " + pf);
}
} finally {
pfIter.finish();
} */
}
}