thredds.inventory

Class NcmlCollectionReader

java.lang.Object

thredds.inventory.NcmlCollectionReader

public class NcmlCollectionReader
extends java.lang.Object

Convert NcML into a CollectionManager. Must have aggregation and scan/scanFmrc element. Tracks inner and outer ncml modifications.

Since:

Feb 24, 2010

Method Summary

Modifier and Type	Method and Description
CollectionManager	getCollectionManager()
org.jdom2.Element	getNcmlInner()
org.jdom2.Element	getNcmlOuter()
static NcmlCollectionReader	open(java.lang.String ncmlLocation, java.util.Formatter errlog) Read an NcML file from a URL location, and construct a NcmlCollectionReader from its scan or scanFmrc element.
static NcmlCollectionReader	readNcml(java.lang.String ncmlString, java.util.Formatter errlog) Read an NcML file from a String, and construct a NcmlCollectionReader from its scan or scanFmrc element.
static NcmlCollectionReader	readNcML(java.lang.String ncmlString, java.util.Formatter errlog) Deprecated. see readNcml(String, Formatter)

Methods inherited from class java.lang.Object

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

Method Detail

readNcML

@Deprecated
public static NcmlCollectionReader readNcML(java.lang.String ncmlString,
                                                        java.util.Formatter errlog)
                                                 throws java.io.IOException

Deprecated. see readNcml(String, Formatter)

Read an NcML file from a String, and construct a NcmlCollectionReader from its scan or scanFmrc element.

Parameters:

ncmlString - the NcML to construct the reader from

errlog - put error messages here

Returns:

the resulting NetcdfDataset

Throws:

java.io.IOException - on read error, or bad referencedDatasetUri URI

readNcml

public static NcmlCollectionReader readNcml(java.lang.String ncmlString,
                                            java.util.Formatter errlog)
                                     throws java.io.IOException

Read an NcML file from a String, and construct a NcmlCollectionReader from its scan or scanFmrc element.

Parameters:

ncmlString - the NcML to construct the reader from

errlog - put error messages here

Returns:

the resulting NetcdfDataset

Throws:

java.io.IOException - on read error, or bad referencedDatasetUri URI

open

public static NcmlCollectionReader open(java.lang.String ncmlLocation,
                                        java.util.Formatter errlog)
                                 throws java.io.IOException

Read an NcML file from a URL location, and construct a NcmlCollectionReader from its scan or scanFmrc element.

Parameters:

ncmlLocation - the URL location string of the NcML document

errlog - put error messages here

Returns:

the resulting NetcdfDataset

Throws:

java.io.IOException - on read error, or bad referencedDatasetUri URI

getNcmlOuter

public org.jdom2.Element getNcmlOuter()

getNcmlInner

public org.jdom2.Element getNcmlInner()

getCollectionManager

public CollectionManager getCollectionManager()