Package ucar.nc2.ncml

Class NcMLWriter

    • 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.

      • 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.

    • Constructor Detail

      • NcMLWriter

        public NcMLWriter()
        Deprecated.

    • Method Detail

      • 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.

      • 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 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,
                        File outFile)
                 throws 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:
        IOException - if there's any problem writing.

      • writeToStream

        public void writeToStream​(org.jdom2.Element elem,
                          OutputStream outStream)
                   throws 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:
        IOException - if there's any problem writing.

      • writeToWriter

        public void writeToWriter​(org.jdom2.Element elem,
                          Writer writer)
                   throws 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:
        IOException - if there's any problem writing.

      • makeValuesElement

        public org.jdom2.Element makeValuesElement​(Variable variable,
                                           boolean allowRegular)
                                    throws 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:
        IOException - if there was an I/O error when reading the variable's data.