ucar.nc2.ncml

Class NcMLWriter

java.lang.Object

ucar.nc2.ncml.NcMLWriter

public class NcMLWriter
extends java.lang.Object

Helper class to write NcML.

See Also:

NetcdfFile, https://www.unidata.ucar.edu/software/netcdf/ncml/

Constructor Summary

Constructors

Constructor and Description
NcMLWriter()

Method Summary

Modifier and Type	Method and Description
static void	main(java.lang.String[] arg)
static org.jdom2.Element	writeAttribute(Attribute att, java.lang.String elementName, org.jdom2.Namespace ns)
static org.jdom2.Element	writeDimension(Dimension dim, org.jdom2.Namespace ns)
static org.jdom2.Element	writeEnumTypedef(EnumTypedef etd, org.jdom2.Namespace ns)
static org.jdom2.Element	writeValues(VariableEnhanced v, org.jdom2.Namespace ns, boolean allowRegular)
java.lang.String	writeXML(NetcdfFile ncfile) Write NcML from specified NetcdfFile to a String.
void	writeXML(NetcdfFile ncfile, java.io.OutputStream os, java.lang.String location) Write a NetcdfFile as an XML document to the specified stream.
void	writeXML(NetcdfFile ncfile, java.lang.String filenameOut) Write a NetcdfFile as an XML document to the specified file.
java.lang.String	writeXML(Variable v)
void	writeXMLexplicit(NetcdfFile ncfile, java.io.OutputStream os, java.lang.String location)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NcMLWriter

public NcMLWriter()

Method Detail

writeXML

public java.lang.String writeXML(NetcdfFile ncfile)
                          throws java.io.IOException

Write NcML from specified NetcdfFile to a String.

Parameters:

ncfile - NcML for this NetcdfFile

Returns:

the NcML in a String

Throws:

java.io.IOException - on io error

writeXML

public java.lang.String writeXML(Variable v)
                          throws java.io.IOException

Throws:

java.io.IOException

writeXML

public void writeXML(NetcdfFile ncfile,
                     java.lang.String filenameOut)
              throws java.io.IOException

Write a NetcdfFile as an XML document to the specified file.

Parameters:

ncfile - NcML for this NetcdfFile

filenameOut - write NcML to this location

Throws:

java.io.IOException - on io error

writeXML

public void writeXML(NetcdfFile ncfile,
                     java.io.OutputStream os,
                     java.lang.String location)
              throws java.io.IOException

Write a NetcdfFile as an XML document to the specified stream.

Parameters:

ncfile - NcML for this NetcdfFile

os - write to this OutputStream

location - normally null, meaning use ncd.getLocation(); otherwise put this into the NcML location

Throws:

java.io.IOException - on io error

writeXMLexplicit

public void writeXMLexplicit(NetcdfFile ncfile,
                             java.io.OutputStream os,
                             java.lang.String location)
                      throws java.io.IOException

Throws:

java.io.IOException

writeAttribute

public static org.jdom2.Element writeAttribute(Attribute att,
                                               java.lang.String elementName,
                                               org.jdom2.Namespace ns)

writeDimension

public static org.jdom2.Element writeDimension(Dimension dim,
                                               org.jdom2.Namespace ns)

writeEnumTypedef

public static org.jdom2.Element writeEnumTypedef(EnumTypedef etd,
                                                 org.jdom2.Namespace ns)

writeValues

public static org.jdom2.Element writeValues(VariableEnhanced v,
                                            org.jdom2.Namespace ns,
                                            boolean allowRegular)

main

public static void main(java.lang.String[] arg)