thredds.catalog.dl.ADNWriter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of netcdf Show documentation
Show all versions of netcdf Show documentation
The NetCDF-Java Library is a Java interface to NetCDF files,
as well as to many other types of scientific data formats.
// $Id: ADNWriter.java 48 2006-07-12 16:15:40Z caron $
/*
* Copyright 1998-2009 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 thredds.catalog.dl;
import thredds.catalog.*;
import thredds.catalog.crawl.CatalogCrawler;
import ucar.nc2.units.DateType;
import ucar.nc2.units.DateRange;
import ucar.nc2.units.TimeDuration;
import org.jdom.*;
import org.jdom.output.*;
import java.io.*;
import java.util.*;
import java.net.URI;
import ucar.unidata.geoloc.LatLonPointImpl;
import ucar.nc2.units.TimeUnit;
import ucar.nc2.constants.FeatureType;
import ucar.unidata.util.StringUtil;
public class ADNWriter {
private static final Namespace defNS = Namespace.getNamespace("http://adn.dlese.org");
private static final String schemaLocation = "http://www.dlese.org/Metadata/adn-item/0.6.50/record.xsd";
// private static final String schemaLocationLocal = defNS.getURI() + " file://c:/dev/metadata/adn/0.6.50/record.xsd";
private String fileDir;
private StringBuffer messBuffer;
public ADNWriter( ) {
}
public void writeDatasetEntries( InvCatalogImpl cat, String fileDir, StringBuffer mess) {
this.fileDir = fileDir;
this.messBuffer = mess;
File dir = new File(fileDir);
if (!dir.exists())
dir.mkdirs();
CatalogCrawler.Listener listener = new CatalogCrawler.Listener() {
public void getDataset(InvDataset ds, Object context) {
doOneDataset(ds);
}
public boolean getCatalogRef(InvCatalogRef dd, Object context) { return true; }
};
ByteArrayOutputStream bis = new ByteArrayOutputStream();
PrintStream ps = new PrintStream( bis);
CatalogCrawler crawler = new CatalogCrawler( CatalogCrawler.USE_ALL, true, listener);
crawler.crawl(cat, null, ps, null);
mess.append("\n*********************\n");
mess.append(bis.toString());
}
private void doOneDataset( InvDataset ds) {
if (!ds.isHarvest()) {
messBuffer.append( " Dataset "+ ds.getName()+ " id = "+ds.getID()+" has harvest = false\n");
} else if (isDatasetUseable( ds, messBuffer)) {
String id = StringUtil.replace(ds.getID(), "/","-");
String fileOutName = fileDir+"/"+id+".adn.xml";
try {
OutputStream out = new BufferedOutputStream(new FileOutputStream( fileOutName));
writeOneItem(ds, out);
out.close();
messBuffer.append(" OK on Write\n");
} catch (IOException ioe) {
messBuffer.append("FAILED on Write "+ioe.getMessage()+"\n");
ioe.printStackTrace();
}
}
}
public boolean isDatasetUseable(InvDataset ds, StringBuffer sbuff) {
boolean ok = true;
sbuff.append("Dataset "+ ds.getName()+ " id = "+ds.getID()+": ");
if (ds.getName() == null) {
ok = false;
sbuff.append(" missing Name field\n");
}
if (ds.getUniqueID() == null) {
ok = false;
sbuff.append(" missing ID field\n");
}
List list = ds.getPublishers();
if ((list == null) || (list.size() == 0)) {
ok = false;
sbuff.append(" must have publisher element that defines the data center\n");
}
String summary = ds.getDocumentation("summary");
if (summary == null) {
ok = false;
sbuff.append(" must have documentation element of type summary\n");
}
String rights = ds.getDocumentation("rights");
if (rights == null) {
ok = false;
sbuff.append(" must have documentation element of type rights\n");
}
sbuff.append(" useable= "+ok+"\n");
return ok;
}
private void writeOneItem( InvDataset ds, OutputStream out) throws IOException {
Element rootElem = new Element("itemRecord", defNS);
Document doc = new Document(rootElem);
writeDataset( ds, rootElem);
rootElem.addNamespaceDeclaration(XMLEntityResolver.xsiNS);
// rootElem.setAttribute("schemaLocation", schemaLocationLocal, XMLEntityResolver.xsiNS);
rootElem.setAttribute("schemaLocation", defNS.getURI()+" "+schemaLocation, XMLEntityResolver.xsiNS);
// Output the document, use standard formatter
//XMLOutputter fmt = new XMLOutputter(" ", true);
XMLOutputter fmt = new XMLOutputter( Format.getPrettyFormat());
fmt.output( doc, out);
}
public void writeDataset(InvDataset ds, Element rootElem) {
// general
Element generalElem = new Element("general", defNS);
rootElem.addContent( generalElem);
generalElem.addContent( new Element("title", defNS).addContent("Dataset "+ds.getFullName()));
generalElem.addContent( new Element("description", defNS).addContent(ds.getDocumentation("summary")));
generalElem.addContent( new Element("language", defNS).addContent("en"));
Element subjects = new Element("subjects", defNS);
generalElem.addContent( subjects);
subjects.addContent( new Element("subject", defNS).addContent("DLESE:Atmospheric science"));
List list = ds.getKeywords();
if (list.size() > 0) {
Element keywords = new Element("keywords", defNS);
generalElem.addContent( keywords);
for (int i=0; i 0) || (ds.getCreators().size() > 0)){
Element contributors = new Element("contributors", defNS);
lifeElem.addContent( contributors);
list = ds.getPublishers();
for (int i=0; i= 0; // should really do a regexp
}
protected Element writeSource(ThreddsMetadata.Source p, String role) {
Element contributor = new Element("contributor", defNS);
contributor.setAttribute("role", role);
Element organization = new Element("organization", defNS);
contributor.addContent( organization);
String name = p.getNameVocab().getText();
int pos = name.indexOf("/");
if (pos > 0) {
organization.addContent( new Element("instName", defNS).addContent(name.substring(0,pos)));
organization.addContent( new Element("instDept", defNS).addContent(name.substring(pos+1)));
} else
organization.addContent( new Element("instName", defNS).addContent(name));
if ((p.getUrl() != null) && p.getUrl().length() > 0)
organization.addContent( new Element("instUrl", defNS).addContent(p.getUrl()));
if (emailOK(p))
organization.addContent( new Element("instEmail", defNS).addContent(p.getEmail()));
return contributor;
}
protected Element writeGeospatialCoverage(ThreddsMetadata.GeospatialCoverage gc) {
Element geos = new Element("geospatialCoverages", defNS);
Element geo = new Element("geospatialCoverage", defNS);
geos.addContent( geo);
Element body = new Element("body", defNS);
geo.addContent( body);
body.addContent( new Element("planet", defNS).addContent("Earth"));
geo.addContent( new Element("geodeticDatumGlobalOrHorz", defNS).addContent("DLESE:WGS84"));
geo.addContent( new Element("projection", defNS).setAttribute("type", "DLESE:Unknown"));
geo.addContent( new Element("coordinateSystem", defNS).setAttribute("type", "DLESE:Geographic latitude and longitude"));
Element bb = new Element("boundBox", defNS);
geo.addContent( bb);
double west = LatLonPointImpl.lonNormal(gc.getLonWest());
double east = LatLonPointImpl.lonNormal(gc.getLonEast());
bb.addContent( new Element("westCoord", defNS).setText( ucar.unidata.util.Format.dfrac( west, 2)));
bb.addContent( new Element("eastCoord", defNS).setText( ucar.unidata.util.Format.dfrac( east, 2)));
bb.addContent( new Element("northCoord", defNS).setText( ucar.unidata.util.Format.dfrac( gc.getLatNorth(), 2)));
bb.addContent( new Element("southCoord", defNS).setText( ucar.unidata.util.Format.dfrac( gc.getLatSouth(), 2)));
bb.addContent( new Element("bbSrcName", defNS).setText( "Calculated from dataset coordinate system by CDM/THREDDS"));
return geos;
}
protected Element writeTemporalCoverage(DateRange dateRange) {
Element tc = new Element("temporalCoverages", defNS);
Element tp = new Element("timeAndPeriod", defNS);
Element ti = new Element("timeInfo", defNS);
tc.addContent(tp.addContent(ti));
Element time;
DateType startDate = dateRange.getStart();
DateType endDate = dateRange.getEnd();
if (endDate.isPresent()) {
String units = "Days ago";
TimeDuration duration = dateRange.getDuration();
double value = -0.0;
try {
TimeUnit tdayUnit = new TimeUnit("days");
value = duration.getValue(tdayUnit);
} catch (Exception e) {
e.printStackTrace();
}
time = new Element("timeRelative", defNS);
Element begin = new Element("begin", defNS);
begin.setAttribute("units", units);
begin.addContent(Double.toString(value));
time.addContent( begin);
Element end = new Element("end", defNS);
end.setAttribute("units", units);
end.addContent("0");
time.addContent( end);
} else {
// LOOK not tested
time = new Element("timeAD", defNS);
Element begin = new Element("begin", defNS);
begin.setAttribute("date", startDate.toDateString());
time.addContent( begin);
Element end = new Element("end", defNS);
end.setAttribute("date", endDate.toDateString());
time.addContent( end);
}
ti.addContent(time);
return tc;
}
// test
private static void doOne( InvCatalogFactory fac, String url) {
System.out.println("***read "+url);
try {
InvCatalogImpl cat = fac.readXML(url);
StringBuilder buff = new StringBuilder();
boolean isValid = cat.check( buff, false);
System.out.println("catalog <" + cat.getName()+ "> "+ (isValid ? "is" : "is not") + " valid");
System.out.println(" validation output=\n" + buff);
// System.out.println(" catalog=\n" + fac.writeXML(cat));
ADNWriter w = new ADNWriter();
StringBuffer sbuff = new StringBuffer();
w.writeDatasetEntries( cat, "C:/temp/adn3", sbuff);
System.out.println(" messages=\n"+sbuff);
} catch (Exception e) {
e.printStackTrace();
}
}
/** testing */
public static void main (String[] args) throws Exception {
InvCatalogFactory catFactory = InvCatalogFactory.getDefaultFactory(true);
// doOne(catFactory, "file:///C:/dev/thredds/catalog/test/data/TestHarvest.xml");
doOne(catFactory, "http://motherlode.ucar.edu:9080/thredds/idd/models.xml");
//doOne(catFactory, "http://motherlode.ucar.edu:8088/thredds/configCatGenModels.xml");
}
}