ucar.nc2.stream

Class CdmRemote

java.lang.Object

ucar.nc2.NetcdfFile

ucar.nc2.stream.CdmRemote

All Implemented Interfaces:

Closeable, AutoCloseable, FileCacheable

public class CdmRemote
extends NetcdfFile

A remote CDM dataset (extending NetcdfFile), using cdmremote protocol to communicate. Similar to Opendap in that it is a remote access protocol using indexed data access. Supports full CDM / netcdf-4 data model.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CdmRemote.Builder<T extends CdmRemote.Builder<T>>

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROTOCOL
static String	SCHEME

Fields inherited from class ucar.nc2.NetcdfFile

cache, IOSP_MESSAGE_ADD_RECORD_STRUCTURE, IOSP_MESSAGE_GET_IOSP, IOSP_MESSAGE_GET_NETCDF_FILE_FORMAT, IOSP_MESSAGE_RANDOM_ACCESS_FILE

Method Summary

Modifier and Type	Method and Description
static CdmRemote.Builder<?>	builder() Get Builder for this class that allows subclassing.
static String	canonicalURL(String urlName) Create the canonical form of the URL.
void	close() Close all resources (files, sockets, etc) associated with this file.
String	getFileTypeDescription() Get a human-readable description for this file type.
String	getFileTypeId() Get the file type id for the underlying data source.
protected StructureDataIterator	getStructureIterator(Structure s, int bufferSize)
protected Array	readData(Variable v, Section section) Do not call this directly, use Variable.read() !! Ranges must be filled (no nulls)
static InputStream	sendQuery(ucar.httpservices.HTTPSession session, String remoteURI, String query)
static void	setAllowCompression(boolean b)
static void	setDebugFlags(DebugFlags debugFlag)
CdmRemote.Builder<?>	toBuilder() Turn into a mutable Builder.
long	writeToFile(String filename)

Methods inherited from class ucar.nc2.NetcdfFile

addLocalFieldsToBuilder, findAttribute, findDimension, findGlobalAttribute, findGlobalAttributeIgnoreCase, findGroup, findVariable, getDetailInfo, getDetailInfo, getDimensions, getFileTypeVersion, getGlobalAttributes, getId, getLastModified, getLocation, getRootGroup, getStructureDataArrayIterator, getTitle, getUnlimitedDimension, getVariables, hasUnlimitedDimension, reacquire, readArrayData, readSection, readSectionArray, readToOutputStream, release, sendIospMessage, setCachedData, setFileCache, showCached, showProxies, toNcml, toString, toStringDebug, writeNcml, writeNcml

Methods inherited from class java.lang.Object

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

Field Detail

PROTOCOL

public static final String PROTOCOL

See Also:

Constant Field Values

SCHEME

public static final String SCHEME

See Also:

Constant Field Values

Method Detail

setDebugFlags

public static void setDebugFlags(DebugFlags debugFlag)

setAllowCompression

public static void setAllowCompression(boolean b)

canonicalURL

public static String canonicalURL(String urlName)

Create the canonical form of the URL. If the urlName starts with "http:", change it to start with "cdmremote:", otherwise leave it alone.

Parameters:

urlName - the url string

Returns:

canonical form

readData

protected Array readData(Variable v,
                         Section section)
                  throws IOException

Description copied from class: NetcdfFile

Do not call this directly, use Variable.read() !! Ranges must be filled (no nulls)

Overrides:

readData in class NetcdfFile

Throws:

IOException

getStructureIterator

protected StructureDataIterator getStructureIterator(Structure s,
                                                     int bufferSize)

Overrides:

getStructureIterator in class NetcdfFile

sendQuery

public static InputStream sendQuery(ucar.httpservices.HTTPSession session,
                                    String remoteURI,
                                    String query)
                             throws IOException

Throws:

IOException

getFileTypeId

public String getFileTypeId()

Description copied from class: NetcdfFile

Get the file type id for the underlying data source.

Overrides:

getFileTypeId in class NetcdfFile

Returns:

registered id of the file type

See Also:

"https://www.unidata.ucar.edu/software/netcdf-java/formats/FileTypes.html"

getFileTypeDescription

public String getFileTypeDescription()

Description copied from class: NetcdfFile

Get a human-readable description for this file type.

Overrides:

getFileTypeDescription in class NetcdfFile

Returns:

description of the file type

See Also:

"https://www.unidata.ucar.edu/software/netcdf-java/formats/FileTypes.html"

writeToFile

public long writeToFile(String filename)
                 throws IOException

Throws:

IOException

close

public void close()

Description copied from class: NetcdfFile

Close all resources (files, sockets, etc) associated with this file. If the underlying file was acquired, it will be released, otherwise closed. if isClosed() already, nothing will happen

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface FileCacheable

Overrides:

close in class NetcdfFile

toBuilder

public CdmRemote.Builder<?> toBuilder()

Description copied from class: NetcdfFile

Turn into a mutable Builder. Can use toBuilder().build() to copy.

Overrides:

toBuilder in class NetcdfFile

builder

public static CdmRemote.Builder<?> builder()

Get Builder for this class that allows subclassing.

See Also:

"https://community.oracle.com/blogs/emcmanus/2010/10/24/using-builder-pattern-subclasses"