ucar.nc2.ncml

Class NcMLWriter

java.lang.Object

ucar.nc2.ncml.NcMLWriter

Deprecated.

use ucar.nc2.write.NcmlWriter

@Deprecated
public class NcMLWriter
extends java.lang.Object

Helper class to write NcML.

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NcMLWriter.WriteVariablesWithNamesPredicate Deprecated. Predicate that returns true for variables whose names are specified to the constructor.

Field Summary

Fields

Modifier and Type	Field and Description
static org.jdom2.Namespace	ncmlDefaultNamespace Deprecated. A default namespace constructed from the NcML URI: http://www.unidata.ucar.edu/namespaces/netcdf/ncml-2.2.
static com.google.common.base.Predicate<Variable>	writeAllVariablesPredicate Deprecated. Predicate that always returns true.
static com.google.common.base.Predicate<Variable>	writeCoordinateVariablesPredicate Deprecated. Predicate that returns true for variables that are coordinate variables.
static com.google.common.base.Predicate<Variable>	writeMetadataVariablesPredicate Deprecated. Predicate that returns true for variables that are metadata variables.
static com.google.common.base.Predicate<Variable>	writeNoVariablesPredicate Deprecated. Predicate that always returns false.

Constructor Summary

Constructors

Constructor and Description
NcMLWriter() Deprecated.

Method Summary

Modifier and Type	Method and Description
org.jdom2.Namespace	getNamespace() Deprecated. Gets the XML namespace for the elements in the NcML.
com.google.common.base.Predicate<Variable>	getWriteVariablesPredicate() Deprecated. Gets the predicate that will be applied to variables to determine wither their values should be written in addition to their metadata.
org.jdom2.output.Format	getXmlFormat() Deprecated. Gets the object that encapsulates XML formatting options.
org.jdom2.Element	makeAttributeElement(Attribute attribute) Deprecated.
org.jdom2.Element	makeDimensionElement(Dimension dim) Deprecated.
org.jdom2.Element	makeEnumTypedefElement(EnumTypedef etd) Deprecated.
org.jdom2.Element	makeExplicitNetcdfElement(NetcdfFile ncFile, java.lang.String location) Deprecated.
org.jdom2.Element	makeGroupElement(Group group) Deprecated.
org.jdom2.Element	makeNetcdfElement(NetcdfFile ncFile, java.lang.String location) Deprecated.
org.jdom2.Element	makeValuesElement(Variable variable, boolean allowRegular) Deprecated. Creates a <values> element from the variable's data.
org.jdom2.Element	makeVariableElement(Variable var, boolean showValues) Deprecated.
void	setNamespace(org.jdom2.Namespace namespace) Deprecated. Sets the XML namespace.
void	setWriteVariablesPredicate(com.google.common.base.Predicate<Variable> predicate) Deprecated. Sets the predicate that will be applied to variables to determine whether their values should be written in addition to their metadata.
void	setXmlFormat(org.jdom2.output.Format xmlFormat) Deprecated.
void	writeToFile(org.jdom2.Element elem, java.io.File outFile) Deprecated. Writes an NcML element to an output file.
void	writeToStream(org.jdom2.Element elem, java.io.OutputStream outStream) Deprecated. Writes an NcML element to an output stream.
java.lang.String	writeToString(org.jdom2.Element elem) Deprecated. Writes an NcML element to a string.
void	writeToWriter(org.jdom2.Element elem, java.io.Writer writer) Deprecated. Writes an NcML element to a Writer.

Methods inherited from class java.lang.Object

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

Field Detail

ncmlDefaultNamespace

public static final org.jdom2.Namespace ncmlDefaultNamespace

Deprecated.

A default namespace constructed from the NcML URI: http://www.unidata.ucar.edu/namespaces/netcdf/ncml-2.2.

writeNoVariablesPredicate

public static final com.google.common.base.Predicate<Variable> writeNoVariablesPredicate

Deprecated.

Predicate that always returns false.

writeMetadataVariablesPredicate

public static final com.google.common.base.Predicate<Variable> writeMetadataVariablesPredicate

Deprecated.

Predicate that returns true for variables that are metadata variables. For such variables, the data is not actually present in the file, so we must include it in the NcML. It could be synthesized (i.e. generated by an IOSP) or specified in a element of the input NcML.

writeCoordinateVariablesPredicate

public static final com.google.common.base.Predicate<Variable> writeCoordinateVariablesPredicate

Deprecated.

Predicate that returns true for variables that are coordinate variables.

writeAllVariablesPredicate

public static final com.google.common.base.Predicate<Variable> writeAllVariablesPredicate

Deprecated.

Predicate that always returns true.

Constructor Detail

NcMLWriter

public NcMLWriter()

Deprecated.

Method Detail

getNamespace

public org.jdom2.Namespace getNamespace()

Deprecated.

Gets the XML namespace for the elements in the NcML. By default, it is ncmlDefaultNamespace.

Returns:

the XML namespace.

setNamespace

public void setNamespace(org.jdom2.Namespace namespace)

Deprecated.

Sets the XML namespace.

Parameters:

namespace - the new namespace. null implies Namespace.NO_NAMESPACE.

getXmlFormat

public org.jdom2.output.Format getXmlFormat()

Deprecated.

Gets the object that encapsulates XML formatting options. By default, the format is pretty with UNIX line separators.

Returns:

the XML formatting options.

setXmlFormat

public void setXmlFormat(org.jdom2.output.Format xmlFormat)

Deprecated.

getWriteVariablesPredicate

public com.google.common.base.Predicate<Variable> getWriteVariablesPredicate()

Deprecated.

Gets the predicate that will be applied to variables to determine wither their values should be written in addition to their metadata. The values will be contained within a <values> element.

Returns:

the predicate.

setWriteVariablesPredicate

public void setWriteVariablesPredicate(com.google.common.base.Predicate<Variable> predicate)

Deprecated.

Sets the predicate that will be applied to variables to determine whether their values should be written in addition to their metadata. The values will be contained within a <values> element.

By default, the predicate will be writeMetadataVariablesPredicate. Their could be data loss if the values of metadata variables aren't included in the NcML, so we recommend that you always use it, possibly as part of a compound predicate. For example, suppose you wanted to print the values of metadata and coordinate variables. Just do:

 Predicate compoundPred =
     Predicates.or(writeMetadataVariablesPredicate, writeCoordinateVariablesPredicate);
 ncmlWriter.setWriteVariablesPredicate(compoundPred);
 

Parameters:

predicate - the predicate to apply.

writeToString

public java.lang.String writeToString(org.jdom2.Element elem)

Deprecated.

Writes an NcML element to a string.

Parameters:

elem - an NcML element.

Returns:

the string that represents the NcML document.

writeToFile

public void writeToFile(org.jdom2.Element elem,
                        java.io.File outFile)
                 throws java.io.IOException

Deprecated.

Writes an NcML element to an output file.

Parameters:

elem - an NcML element.

outFile - the file to write the NcML document to.

Throws:

java.io.IOException - if there's any problem writing.

writeToStream

public void writeToStream(org.jdom2.Element elem,
                          java.io.OutputStream outStream)
                   throws java.io.IOException

Deprecated.

Writes an NcML element to an output stream.

Parameters:

elem - an NcML element.

outStream - the stream to write the NcML document to. Will be closed at end of the method.

Throws:

java.io.IOException - if there's any problem writing.

writeToWriter

public void writeToWriter(org.jdom2.Element elem,
                          java.io.Writer writer)
                   throws java.io.IOException

Deprecated.

Writes an NcML element to a Writer.

Parameters:

elem - an NcML element.

writer - the Writer to write the NcML document to. Will be closed at end of the method.

Throws:

java.io.IOException - if there's any problem writing.

makeExplicitNetcdfElement

public org.jdom2.Element makeExplicitNetcdfElement(NetcdfFile ncFile,
                                                   java.lang.String location)

Deprecated.

makeNetcdfElement

public org.jdom2.Element makeNetcdfElement(NetcdfFile ncFile,
                                           java.lang.String location)

Deprecated.

makeGroupElement

public org.jdom2.Element makeGroupElement(Group group)

Deprecated.

makeEnumTypedefElement

public org.jdom2.Element makeEnumTypedefElement(EnumTypedef etd)

Deprecated.

makeDimensionElement

public org.jdom2.Element makeDimensionElement(Dimension dim)
                                       throws java.lang.IllegalArgumentException

Deprecated.

Throws:

java.lang.IllegalArgumentException

makeVariableElement

public org.jdom2.Element makeVariableElement(Variable var,
                                             boolean showValues)

Deprecated.

makeAttributeElement

public org.jdom2.Element makeAttributeElement(Attribute attribute)

Deprecated.

makeValuesElement

public org.jdom2.Element makeValuesElement(Variable variable,
                                           boolean allowRegular)
                                    throws java.io.IOException

Deprecated.

Creates a <values> element from the variable's data.

Parameters:

variable - the variable to read values from

allowRegular - true if regular values should be represented with start, increment, and npts attributes instead of space-separated Element text. Has no effect if the data isn't regular.

Returns:

the <values> element.

Throws:

java.io.IOException - if there was an I/O error when reading the variable's data.