dap4.cdmshared

Class CDMUtil

java.lang.Object

dap4.cdmshared.CDMUtil

public abstract class CDMUtil
extends Object

CDM related Constants and utilities common to client and server code

Constructor Summary

Constructors

Constructor and Description
CDMUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static Class	cdmElementClass(DataType dt)
static DapType	cdmtype2daptype(DataType datatype, boolean unsigned)
static int[]	computeEffectiveShape(List<DapDimension> dimset) Compute the shape inferred from a set of slices.
static Object	convertVector(DapType dsttype, DapType srctype, Object src) Convert an array of one type of values to another type
static List<Range>	createCDMRanges(List<Slice> slices)
static Object	createVector(AtomicType atype, long count) Given an arbitrary Array (including ArrayStructure), produce a new Array that represents the slice defined by the section.
static DataType	daptype2cdmtype(DapType daptype)
static int	daptypeSize(AtomicType atomtype) Conmpute the size, in databuffer, of the daptype wrt to a serialization; 0 if undefined.
static DataType	enumtypefor(DapType dt)
static double	extractDoubleValue(AtomicType atomtype, D4DataAtomic dataset, int index) Extract, as a double, value from a (presumably) atomic typed array of values; dataset position is presumed correct.
static long	extractLongValue(AtomicType atomtype, D4DataAtomic dataset, long index) Extract, as a long, value from a (presumably) atomic typed array of values; dataset position is presumed correct.
static Object	extractVector(D4DataAtomic dataset, long index, long count) Extract, as an object, n consecutive values of an atomic typed array of values
static String	getChecksumString(byte[] checksum)
static boolean	hasVLEN(List<Range> ranges)
static boolean	hasVLEN(Variable v) Test if any dimension is variable length
static boolean	isWhole(List<Range> rangelist, List<DapDimension> dimset, int start, int stop) Test a List against a List to see if the range list represents the whole set of dimensions within the specified indices.
static boolean	isWhole(List<Range> rangelist, List<Slice> slices) Test a List against a List to see if the range list is whole wrt the slices
static boolean	isWhole(List<Range> rangelist, Variable var) Test a List against the CDM variable's dimensions to see if the range list is whole wrt the dimensions
static List<Slice>	rangeConvert(List<Range> rangelist) Convert a list of ucar.ma2.Range to a list of Slice
static Variable	unwrap(Variable var) NetcdfDataset can end up wrapping a variable in multiple wrapping classes (e.g.
static NetcdfFile	unwrapfile(NetcdfFile file) NetcdfDataset can wrap a NetcdfFile.

Methods inherited from class java.lang.Object

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

Constructor Detail

CDMUtil

public CDMUtil()

Method Detail

rangeConvert

public static List<Slice> rangeConvert(List<Range> rangelist)
                                throws DapException

Convert a list of ucar.ma2.Range to a list of Slice

Parameters:

rangelist - the set of ucar.ma2.Range

Throws:

DapException

isWhole

public static boolean isWhole(List<Range> rangelist,
              List<DapDimension> dimset,
              int start,
              int stop)
                       throws DapException

Test a List against a List to see if the range list represents the whole set of dimensions within the specified indices.

Parameters:

rangelist - the set of ucar.ma2.Range

dimset - the set of DapDimensions

start - start looking here

stop - stop looking here

Throws:

DapException

isWhole

public static boolean isWhole(List<Range> rangelist,
              List<Slice> slices)
                       throws DapException

Test a List against a List to see if the range list is whole wrt the slices

Parameters:

rangelist - the set of ucar.ma2.Range

slices - the set of slices

Throws:

DapException

isWhole

public static boolean isWhole(List<Range> rangelist,
              Variable var)
                       throws DapException

Test a List against the CDM variable's dimensions to see if the range list is whole wrt the dimensions

Parameters:

rangelist - the set of ucar.ma2.Range

var - the cdm var

Throws:

DapException

createCDMRanges

public static List<Range> createCDMRanges(List<Slice> slices)
                                   throws IOException

Throws:

IOException

unwrap

public static Variable unwrap(Variable var)

NetcdfDataset can end up wrapping a variable in multiple wrapping classes (e.g. VariableDS). Goal of this procedure is to get down to the lowest level Variable instance

Parameters:

var - possibly wrapped variable

Returns:

the lowest level Variable instance

unwrapfile

public static NetcdfFile unwrapfile(NetcdfFile file)

NetcdfDataset can wrap a NetcdfFile. Goal of this procedure is to get down to the lowest level NetcdfFile instance.

Parameters:

file - NetcdfFile or NetcdfDataset

Returns:

the lowest level NetcdfFile instance

hasVLEN

public static boolean hasVLEN(List<Range> ranges)

hasVLEN

public static boolean hasVLEN(Variable v)

Test if any dimension is variable length

enumtypefor

public static DataType enumtypefor(DapType dt)

cdmtype2daptype

public static DapType cdmtype2daptype(DataType datatype,
                      boolean unsigned)

daptype2cdmtype

public static DataType daptype2cdmtype(DapType daptype)

daptypeSize

public static int daptypeSize(AtomicType atomtype)

Conmpute the size, in databuffer, of the daptype wrt to a serialization; 0 if undefined.

Parameters:

atomtype - The type of interest

Returns:

the size, in databuffer

cdmElementClass

public static Class cdmElementClass(DataType dt)

computeEffectiveShape

public static int[] computeEffectiveShape(List<DapDimension> dimset)

Compute the shape inferred from a set of slices. 'Effective' means that any trailing vlen will be ignored.

Parameters:

dimset - from which to generate shape

Returns:

extractLongValue

public static long extractLongValue(AtomicType atomtype,
                    D4DataAtomic dataset,
                    long index)
                             throws DataException

Extract, as a long, value from a (presumably) atomic typed array of values; dataset position is presumed correct.

Parameters:

atomtype - type of object to extract

dataset - D4Data containing the objects

index - Which element of dataset to read

Returns:

resulting value as a long

Throws:

ForbiddenConversionException - if cannot convert to long

DataException

extractDoubleValue

public static double extractDoubleValue(AtomicType atomtype,
                        D4DataAtomic dataset,
                        int index)
                                 throws DataException

Extract, as a double, value from a (presumably) atomic typed array of values; dataset position is presumed correct.

Parameters:

atomtype - type of object to extract

dataset - D4Data containing the objects

index - Which element of dataset to read

Returns:

resulting value as a double

Throws:

ForbiddenConversionException - if cannot convert to double

DataException

extractVector

public static Object extractVector(D4DataAtomic dataset,
                   long index,
                   long count)
                            throws DataException

Extract, as an object, n consecutive values of an atomic typed array of values

Parameters:

dataset - D4Data containing the objects

index - Starting element to read

count - Number of elements to read

Returns:

resulting array of values as an object

Throws:

DataException

convertVector

public static Object convertVector(DapType dsttype,
                   DapType srctype,
                   Object src)

Convert an array of one type of values to another type

Parameters:

dsttype - target type

srctype - source type

src - array of values to convert

Returns:

resulting array of converted values as an object

createVector

public static Object createVector(AtomicType atype,
                  long count)

Given an arbitrary Array (including ArrayStructure), produce a new Array that represents the slice defined by the section. For now, we create a simple array of the relevant type and fill it by extracting the values specified by the section. param array the array from which the section is extracted param section determines what to extract throws DapException returns the slice array

getChecksumString

public static String getChecksumString(byte[] checksum)