thredds.wcs.v1_1_0.XMLwriter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
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.
The newest version!
/*
 * 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.wcs.v1_1_0;

import org.jdom2.Namespace;
import org.jdom2.Document;
import org.jdom2.Element;
import org.jdom2.output.XMLOutputter;
import org.jdom2.output.Format;
import ucar.nc2.units.DateFormatter;
import ucar.nc2.dt.GridDataset;

import java.util.*;

/**
 * Generates WCS 1.1.0 XML responses.
 *
 * @author edavis
 * @since 4.0
 */
public class XMLwriter
{
  protected static final Namespace wcsNS = Namespace.getNamespace( "http://www.opengis.net/wcs/1.1" );
  protected static final Namespace owcsNS = Namespace.getNamespace( "http://www.opengis.net/wcs/1.1/ows" );
  protected static final Namespace owsNS = Namespace.getNamespace( "http://www.opengis.net/ows");

  private XMLOutputter xmlOutputter;

  public XMLwriter()
  {
    xmlOutputter = new XMLOutputter( Format.getPrettyFormat() );
  }

  public static String seqDate;
  static {
    // will get incremented each time we start up
    DateFormatter formatter = new DateFormatter();
    seqDate = formatter.toDateTimeStringISO(new Date());
  }
  //////////////////////////////////////////////////////////////////////////////////
  public enum ExceptionCodes
  {
    MissingParameterValue, InvalidParameterValue, VersionNegotiationFailed,
    InvalidUpdateSequence, NoApplicableCode
  }

  public Document generateExceptionReport( ExceptionCodes code, String locator, String message)
  {
    Element rootElem = new Element( "ExceptionReport", owsNS);

    rootElem.addNamespaceDeclaration( owsNS );
    rootElem.setAttribute( "version", "1.0.0" );
    // rootElem.setAttribute( "language", "en" );

    Element exceptionElem = new Element( "Exception", owsNS);
    exceptionElem.setAttribute( "code", code.toString());
    if ( locator != null && locator.length() != 0)
      exceptionElem.setAttribute( "locator", locator);

    if ( message != null && message.length() != 0)
    {
      Element excTextElem = new Element( "ExceptionText", owsNS);
      excTextElem.addContent( message);

      exceptionElem.addContent( excTextElem);
    }
    rootElem.addContent( exceptionElem);

    return new Document( rootElem );
  }

  public Document generateCapabilities( String serverURL, GridDataset dataset, List sections )
  {
    Element capabilitiesElem = new Element( "Capabilities", owsNS );
    capabilitiesElem.addNamespaceDeclaration( owsNS );


    return new Document( capabilitiesElem );
  }

//  public static void main( String[] args )
//  {
//    List keywds = new ArrayList();
//    keywds.add( "keywd1");
//    keywds.add( "keywd2");
//    List servTypVers = new ArrayList();
//    servTypVers.add( "1.1.0" );
//    servTypVers.add( "1.0.0" );
//
//    List accessConsts = new ArrayList();
//    accessConsts.add("NONE");
//
//    XMLwriter xmlWriter = new XMLwriter();
//
//    Element si = xmlWriter.generateServiceIdentification( "title", "abs", keywds,"WCS", servTypVers, "NONE", accessConsts);
//
//    XMLOutputter xmlOutputter = new XMLOutputter( Format.getPrettyFormat() );
//
//    System.out.println( xmlOutputter.outputString( si) );
//  }
}