DODSNetcdfFile (opendap 4.6.1 API)

java.lang.Object
- ucar.nc2.NetcdfFile
- - ucar.nc2.dods.DODSNetcdfFile

All Implemented Interfaces:

java.lang.AutoCloseable, ucar.nc2.util.cache.FileCacheable
```
@NotThreadSafe
public class DODSNetcdfFile
extends ucar.nc2.NetcdfFile
```
Access to DODS datasets through the Netcdf API.

See Also:

NetcdfFile

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`debugAttributes`
`static boolean`	`debugCached`
`static boolean`	`debugCE`
`static boolean`	`debugCharArray`
`static boolean`	`debugConstruct`
`static boolean`	`debugConvertData`
`static boolean`	`debugDataResult`
`static boolean`	`debugOpenResult`
`static boolean`	`debugOpenTime`
`static boolean`	`debugPreload`
`static boolean`	`debugServerCall`
`static boolean`	`debugTime`
`static boolean`	`showNCfile`

Fields inherited from class ucar.nc2.NetcdfFile
cache, cacheName, debugCompress, debugSPI, dimensions, gattributes, id, IOSP_MESSAGE_ADD_RECORD_STRUCTURE, IOSP_MESSAGE_CONVERT_RECORD_STRUCTURE, IOSP_MESSAGE_RANDOM_ACCESS_FILE, IOSP_MESSAGE_REMOVE_RECORD_STRUCTURE, location, reservedCdl, reservedFullName, reservedSectionSpec, rootGroup, showRequest, spi, title, variables

Constructor Summary

Constructors
Constructor and Description
`DODSNetcdfFile(java.lang.String datasetURL)` Open a DODS file.
`DODSNetcdfFile(java.lang.String datasetURL, ucar.nc2.util.CancelTask cancelTask)` Open a DODS file, allow user control over preloading string arrays and making structure data available through netcdf API.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static java.lang.String`	`canonicalURL(java.lang.String urlName)` Create the canonical form of the URL.
`void`	`close()`
`static int`	`convertToDODSType(ucar.ma2.DataType dataType, boolean isUnsigned)` Get the DODS data class corresponding to the Netcdf data type.
`static ucar.ma2.DataType`	`convertToNCType(BaseType dtype)` Get the Netcdf data type corresponding to the DODS BaseType class.
`static ucar.ma2.DataType`	`convertToNCType(int dodsDataType)` Get the Netcdf data type corresponding to the DODS data type.
`void`	`getDetailInfo(java.util.Formatter f)`
`static java.lang.String`	`getDODSConstraintName(ucar.nc2.Variable var)` Return a variable name suitable for use in a DAP constraint expression.
`java.lang.String`	`getFileTypeDescription()`
`java.lang.String`	`getFileTypeId()`
`static boolean`	`isUnsigned(BaseType dtype)` Get whether this is an unsigned type.
`static boolean`	`isUnsigned(int dodsDataType)` Get whether this is an unsigned type.
`static void`	`main(java.lang.String[] arg)`
`protected int[]`	`makeShape(DArray dodsArray)`
`java.util.List<ucar.ma2.Array>`	`readArrays(java.util.List<ucar.nc2.Variable> preloadVariables)` Make a single call to the DODS Server to read all the named variable's data in one client/server roundtrip.
`protected ucar.ma2.Array`	`readData(ucar.nc2.Variable v, ucar.ma2.Section section)`
`ucar.ma2.Array`	`readSection(java.lang.String variableSection)`
`long`	`readToByteChannel(ucar.nc2.Variable v, ucar.ma2.Section section, java.nio.channels.WritableByteChannel channel)`
`ucar.ma2.Array`	`readWithCE(ucar.nc2.Variable v, java.lang.String CE)`
`protected void`	`reGroup()` Go thru the variables/structure-variables and their attributes and move to the proper groups.
`protected void`	`reGroupVariable(ucar.nc2.Group rootgroup, DODSVariable dodsv)` Deprecated.
`protected void`	`reGroupVariableAttributes(ucar.nc2.Group rootgroup, ucar.nc2.Variable v)`
`static void`	`setAllowCompression(boolean b)` Set whether to allow messages to be compressed.
`static void`	`setAllowDeflate(boolean b)` Deprecated. use setAllowCompression
`static void`	`setAllowSessions(boolean b)` Set whether to allow sessions by allowing cookies.
`static void`	`setCoordinateVariablePreloadSize(int size)` If preloading, set maximum size of coordinate variables to be preloaded.
`static void`	`setDebugFlags(ucar.nc2.util.DebugFlags debugFlag)` Debugging flags.
`static void`	`setPreload(boolean b)` Set whether small variables are preloaded; only turn off for debugging.

Methods inherited from class ucar.nc2.NetcdfFile
addAttribute, addAttribute, addDimension, addGroup, addStringVariable, addVariable, addVariable, addVariableAttribute, canOpen, empty, findAttribute, findAttValueIgnoreCase, findDimension, findGlobalAttribute, findGlobalAttributeIgnoreCase, findGroup, findVariable, findVariable, findVariableByAttribute, finish, getCacheName, getDetailInfo, getDimensions, getFileTypeVersion, getGlobalAttributes, getId, getIosp, getLastModified, getLocation, getRootGroup, getStructureIterator, getTitle, getUnlimitedDimension, getVariables, hasUnlimitedDimension, iospRegistered, makeFullName, makeFullName, makeFullNameSectionSpec, makeFullNameWithString, makeNameUnescaped, makeRecordStructure, makeRootGroup, makeValidCDLName, makeValidCdmObjectName, makeValidPathName, makeValidSectionSpecName, open, open, open, open, open, open, openInMemory, openInMemory, openInMemory, openInMemory, reacquire, read, readAttributeDouble, readAttributeInteger, readToOutputStream, registerIOProvider, registerIOProvider, registerIOProvider, release, removeDimension, removeRecordStructure, removeVariable, sendIospMessage, setCacheName, setFileCache, setId, setImmutable, setLocation, setProperty, setTitle, showCached, showProxies, syncExtend, toString, toStringDebug, toStringEnd, toStringStart, toStringStart, writeCDL, writeCDL, writeCDL, writeNcML, writeNcML

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - debugCE
```
public static boolean debugCE
```
  - debugServerCall
```
public static boolean debugServerCall
```
  - debugOpenResult
```
public static boolean debugOpenResult
```
  - debugDataResult
```
public static boolean debugDataResult
```
  - debugCharArray
```
public static boolean debugCharArray
```
  - debugConvertData
```
public static boolean debugConvertData
```
  - debugConstruct
```
public static boolean debugConstruct
```
  - debugPreload
```
public static boolean debugPreload
```
  - debugTime
```
public static boolean debugTime
```
  - showNCfile
```
public static boolean showNCfile
```
  - debugAttributes
```
public static boolean debugAttributes
```
  - debugCached
```
public static boolean debugCached
```
  - debugOpenTime
```
public static boolean debugOpenTime
```
- Constructor Detail
  - DODSNetcdfFile
```
public DODSNetcdfFile(java.lang.String datasetURL)
               throws java.io.IOException
```
    Open a DODS file.
    
    Parameters:
    
    datasetURL - URL of the file. This should start with the protocol "dods:" It may also start with protocol "http:".
    
    Throws:
    
    java.io.IOException - on io error
    
    java.net.MalformedURLException
  - DODSNetcdfFile
```
public DODSNetcdfFile(java.lang.String datasetURL,
                      ucar.nc2.util.CancelTask cancelTask)
               throws java.io.IOException
```
    Open a DODS file, allow user control over preloading string arrays and making structure data available through netcdf API.
    
    Parameters:
    
    datasetURL - URL of the file. This should start with the protocol "dods:" or "http:".
    
    cancelTask - check if task is cancelled. may be null.
    
    Throws:
    
    java.io.IOException - on io error
    
    java.net.MalformedURLException
- Method Detail
  - setAllowSessions
```
public static void setAllowSessions(boolean b)
```
    Set whether to allow sessions by allowing cookies. This only affects requests to the TDS. Setting this to true can eliminate consistency problems for datasets that are being updated.
    
    Parameters:
    
    b - true or false. default is false.
  - setAllowDeflate
```
public static void setAllowDeflate(boolean b)
```
    Deprecated. use setAllowCompression
    
    Set whether to allow messages to be compressed.
    
    Parameters:
    
    b - true or false.
  - setAllowCompression
```
public static void setAllowCompression(boolean b)
```
    Set whether to allow messages to be compressed.
    
    Parameters:
    
    b - true or false.
  - setDebugFlags
```
public static void setDebugFlags(ucar.nc2.util.DebugFlags debugFlag)
```
    Debugging flags. This is a way to decouple setting flags from particular implementations.
    
    Parameters:
    
    debugFlag - set of debug flags.
  - setPreload
```
public static void setPreload(boolean b)
```
    Set whether small variables are preloaded; only turn off for debugging.
    
    Parameters:
    
    b - true if small variables are preloaded (default true)
  - setCoordinateVariablePreloadSize
```
public static void setCoordinateVariablePreloadSize(int size)
```
    If preloading, set maximum size of coordinate variables to be preloaded.
    
    Parameters:
    
    size - maximum size of coordinate variables to be preloaded.
  - canonicalURL
```
public static java.lang.String canonicalURL(java.lang.String urlName)
```
    Create the canonical form of the URL. If the urlName starts with "http:" or "https:", change it to start with "dods:", otherwise leave it alone.
    
    Parameters:
    
    urlName - the url string
    
    Returns:
    
    canonical form
  - close
```
public void close()
           throws java.io.IOException
```
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface ucar.nc2.util.cache.FileCacheable
    
    Overrides:
    
    close in class ucar.nc2.NetcdfFile
    
    Throws:
    
    java.io.IOException
  - reGroup
```
protected void reGroup()
                throws DAP2Exception
```
    Go thru the variables/structure-variables and their attributes and move to the proper groups.
    
    Throws:
    
    DAP2Exception
  - reGroupVariable
```
@Deprecated
protected void reGroupVariable(ucar.nc2.Group rootgroup,
                                            DODSVariable dodsv)
                                     throws DAP2Exception
```
    Deprecated.
    
    Throws:
    
    DAP2Exception
  - reGroupVariableAttributes
```
protected void reGroupVariableAttributes(ucar.nc2.Group rootgroup,
                                         ucar.nc2.Variable v)
                                  throws DAP2Exception
```
    Throws:
    
    DAP2Exception
  - makeShape
```
protected int[] makeShape(DArray dodsArray)
```
  - getDODSConstraintName
```
public static java.lang.String getDODSConstraintName(ucar.nc2.Variable var)
```
    Return a variable name suitable for use in a DAP constraint expression. [Original code seemed wrong because structures can be nested and hence would have to use the full name just like non-structures]
    
    Parameters:
    
    var - The variable whose name will appear in the CE
    
    Returns:
    
    The name in a form suitable for use in a cE
  - convertToDODSType
```
public static int convertToDODSType(ucar.ma2.DataType dataType,
                                    boolean isUnsigned)
```
    Get the DODS data class corresponding to the Netcdf data type. This is the inverse of convertToNCType().
    
    Parameters:
    
    dataType - Netcdf data type.
    
    isUnsigned - if its unsigned
    
    Returns:
    
    the corresponding DODS type enum, from opendap.dap.Attribute.XXXX.
  - convertToNCType
```
public static ucar.ma2.DataType convertToNCType(int dodsDataType)
```
    Get the Netcdf data type corresponding to the DODS data type. This is the inverse of convertToDODSType().
    
    Parameters:
    
    dodsDataType - DODS type enum, from dods.dap.Attribute.XXXX.
    
    Returns:
    
    the corresponding netcdf DataType.
    
    See Also:
    
    isUnsigned(int)
  - isUnsigned
```
public static boolean isUnsigned(int dodsDataType)
```
    Get whether this is an unsigned type.
    
    Parameters:
    
    dodsDataType - DODS type enum, from dods.dap.Attribute.XXXX.
    
    Returns:
    
    true if unsigned
  - convertToNCType
```
public static ucar.ma2.DataType convertToNCType(BaseType dtype)
```
    Get the Netcdf data type corresponding to the DODS BaseType class. This is the inverse of convertToDODSType().
    
    Parameters:
    
    dtype - DODS BaseType.
    
    Returns:
    
    the corresponding netcdf DataType.
    
    See Also:
    
    isUnsigned(int)
  - isUnsigned
```
public static boolean isUnsigned(BaseType dtype)
```
    Get whether this is an unsigned type.
    
    Parameters:
    
    dtype - DODS BaseType.
    
    Returns:
    
    true if unsigned
  - readArrays
```
public java.util.List<ucar.ma2.Array> readArrays(java.util.List<ucar.nc2.Variable> preloadVariables)
                                          throws java.io.IOException
```
    Make a single call to the DODS Server to read all the named variable's data in one client/server roundtrip.
    
    Overrides:
    
    readArrays in class ucar.nc2.NetcdfFile
    
    Parameters:
    
    preloadVariables - list of type Variable
    
    Returns:
    
    list of type Array, contains the data
    
    Throws:
    
    java.io.IOException - on error
  - readSection
```
public ucar.ma2.Array readSection(java.lang.String variableSection)
                           throws java.io.IOException,
                                  ucar.ma2.InvalidRangeException
```
    Overrides:
    
    readSection in class ucar.nc2.NetcdfFile
    
    Throws:
    
    java.io.IOException
    
    ucar.ma2.InvalidRangeException
  - readData
```
protected ucar.ma2.Array readData(ucar.nc2.Variable v,
                                  ucar.ma2.Section section)
                           throws java.io.IOException,
                                  ucar.ma2.InvalidRangeException
```
    Overrides:
    
    readData in class ucar.nc2.NetcdfFile
    
    Throws:
    
    java.io.IOException
    
    ucar.ma2.InvalidRangeException
  - readToByteChannel
```
public long readToByteChannel(ucar.nc2.Variable v,
                              ucar.ma2.Section section,
                              java.nio.channels.WritableByteChannel channel)
                       throws java.io.IOException,
                              ucar.ma2.InvalidRangeException
```
    Overrides:
    
    readToByteChannel in class ucar.nc2.NetcdfFile
    
    Throws:
    
    java.io.IOException
    
    ucar.ma2.InvalidRangeException
  - readWithCE
```
public ucar.ma2.Array readWithCE(ucar.nc2.Variable v,
                                 java.lang.String CE)
                          throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getDetailInfo
```
public void getDetailInfo(java.util.Formatter f)
```
    Overrides:
    
    getDetailInfo in class ucar.nc2.NetcdfFile
  - getFileTypeId
```
public java.lang.String getFileTypeId()
```
    Overrides:
    
    getFileTypeId in class ucar.nc2.NetcdfFile
  - getFileTypeDescription
```
public java.lang.String getFileTypeDescription()
```
    Overrides:
    
    getFileTypeDescription in class ucar.nc2.NetcdfFile
  - main
```
public static void main(java.lang.String[] arg)
```

Class DODSNetcdfFile

Field Summary

Fields inherited from class ucar.nc2.NetcdfFile

Constructor Summary

Method Summary

Methods inherited from class ucar.nc2.NetcdfFile

Methods inherited from class java.lang.Object

Field Detail

debugCE

debugServerCall

debugOpenResult

debugDataResult

debugCharArray

debugConvertData

debugConstruct

debugPreload

debugTime

showNCfile

debugAttributes

debugCached

debugOpenTime

Constructor Detail

DODSNetcdfFile

DODSNetcdfFile

Method Detail

setAllowSessions

setAllowDeflate

setAllowCompression

setDebugFlags

setPreload

setCoordinateVariablePreloadSize

canonicalURL

close

reGroup

reGroupVariable

reGroupVariableAttributes

makeShape

getDODSConstraintName

convertToDODSType

convertToNCType

isUnsigned

convertToNCType

isUnsigned

readArrays

readSection

readData

readToByteChannel

readWithCE

getDetailInfo

getFileTypeId

getFileTypeDescription

main