thredds.catalog2.xml.writer.stax.CatalogElementWriter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdm 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.catalog2.xml.writer.stax;

import thredds.catalog2.Catalog;
import thredds.catalog2.Service;
import thredds.catalog2.Property;
import thredds.catalog2.xml.writer.ThreddsXmlWriterException;
import thredds.catalog2.xml.names.CatalogNamespace;
import thredds.catalog2.xml.names.CatalogElementNames;

import javax.xml.stream.XMLStreamWriter;
import javax.xml.stream.XMLStreamException;

import ucar.nc2.units.DateFormatter;

/**
 * _more_
 *
 * @author edavis
 * @since 4.0
 */
public class CatalogElementWriter implements AbstractElementWriter
{
  private org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger( getClass() );

  // ToDo How wire catalog elements together?
//  public static enum CatalogElementWriterFactory implements AbstractElementWriterFactory
//  {
//    SINGLETON;
//
//    private List factories;
//
//    CatalogElementWriterFactory()
//    {
//      this.factories = Collections.emptyList();
//    }
//
//    public void setElementWriterFactoryList( List factoryList )
//    {
//      this.factories = factoryList;
//    }
//  }

  public CatalogElementWriter() {}

  public void writeElement( Catalog catalog, XMLStreamWriter writer, int nestLevel )
          throws ThreddsXmlWriterException
  {
    String indentString = StaxWriter.getIndentString( nestLevel );
    try
    {
      if ( nestLevel == 0 )
      {
        writer.writeStartDocument();
        writer.writeCharacters( "\n" );
      }
      else
        writer.writeCharacters( indentString );
      
      boolean isEmptyElement = catalog.getServices().isEmpty()
                               && catalog.getProperties().isEmpty()
                               && catalog.getDatasets().isEmpty();
      if ( isEmptyElement )
        writer.writeEmptyElement( CatalogElementNames.CatalogElement.toString() );
      else
        writer.writeStartElement( CatalogElementNames.CatalogElement.toString() );
      if ( nestLevel == 0 )
      {
        writer.writeNamespace( CatalogNamespace.CATALOG_1_0.getStandardPrefix(),
                               CatalogNamespace.CATALOG_1_0.getNamespaceUri() );
        writer.writeNamespace( CatalogNamespace.XLINK.getStandardPrefix(),
                               CatalogNamespace.XLINK.getNamespaceUri() );
      }
      if ( catalog.getName() != null )
        writer.writeAttribute( CatalogElementNames.CatalogElement_Name.toString(), catalog.getName() );
      if ( catalog.getVersion() != null )
        writer.writeAttribute( CatalogElementNames.CatalogElement_Version.toString(), catalog.getVersion() );

      if ( catalog.getExpires() != null )
      {
        writer.writeAttribute( CatalogElementNames.CatalogElement_Expires.toString(),
                               catalog.getExpires().toDateTimeStringISO());
      }
      if ( catalog.getLastModified() != null )
      {
        writer.writeAttribute( CatalogElementNames.CatalogElement_LastModified.toString(),
                               catalog.getLastModified().toDateTimeStringISO());
      }
      writer.writeCharacters( "\n" );
      for ( Service curService : catalog.getServices() )
        new ServiceElementWriter().writeElement( curService, writer, nestLevel + 1 );
      for ( Property curProperty : catalog.getProperties() )
        new PropertyElementWriter().writeElement( curProperty, writer, nestLevel + 1 );

      if ( ! isEmptyElement )
      {
        writer.writeCharacters( indentString );
        writer.writeEndElement();
        writer.writeCharacters( "\n" );
      }
      if ( nestLevel == 0)
        writer.writeEndDocument();
      writer.flush();
      if ( nestLevel == 0 )
        writer.close();
    }
    catch ( XMLStreamException e )
    {
      log.error( "writeElement(): Failed while writing to XMLStreamWriter: " + e.getMessage());
      throw new ThreddsXmlWriterException( "Failed while writing to XMLStreamWriter: " + e.getMessage(), e );
    }
  }
}