dap4.cdm.dsp

Class CDMDSP

java.lang.Object

dap4.dap4lib.AbstractDSP

dap4.cdm.dsp.CDMDSP

All Implemented Interfaces:

DSP

public class CDMDSP
extends AbstractDSP

Wrap CDM source (NetcdfDataset) to be a DSP This basically means wrapping various (CDM)Array object to look like DataVariable objects. Currently only used on server side

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed
protected NodeMap<Variable,DapStructure>	compoundmap
protected static boolean	DEBUG
protected DMRFactory	dmrfactory
protected static boolean	DUMPCDL
protected static java.util.Set<NetcdfDataset.Enhance>	ENHANCEMENT
protected static java.lang.String	FILLVALUE
protected static boolean	nc4loaded
protected NetcdfDataset	ncdfile
protected NodeMap<CDMNode,DapNode>	nodemap
protected NodeMap<Variable,DapVariable>	varmap
protected NodeMap<Variable,DapSequence>	vlenmap

Fields inherited from class dap4.dap4lib.AbstractDSP

context, DAPVERSION, dmr, DMRNS, DMRVERSION, location, PARSEDEBUG, rootcursor, TESTING, UCARTAGOPAQUE, UCARTAGORIGTYPE, UCARTAGUNLIMITED, UCARTAGVLEN, USEDOM, variables

Constructor Summary

Constructors

Constructor and Description
CDMDSP()
CDMDSP(java.lang.String path)

Method Summary

Modifier and Type	Method and Description
protected void	addToParent(DapNode parent, DapVariable dapvar)
protected DapVariable	buildatomicvar(Variable cdmvar, DapNode parent)
protected DapAttribute	buildattribute(Attribute cdmattr)
protected void	buildattributes(DapNode node, AttributeContainer attributes)
protected DapStructure	buildcompoundtype(Variable cdmvar, DapNode parent)
protected DapDimension	builddim(Dimension cdmdim)
protected void	builddimrefs(DapVariable dapvar, java.util.List<Dimension> cdmdims) Assign dimensions to a variable
void	buildDMR() Extract the metadata from the NetcdfDataset and build the DMR.
protected DapEnumeration	buildenum(EnumTypedef cdmenum)
protected DapVariable	buildenumvar(Variable cdmvar)
protected DapGroup	buildgroup(Group cdmgroup)
protected void	buildmaps(DapVariable dapvar, Variable var)
protected DapVariable	buildopaquevar(Variable cdmvar)
protected DapSequence	buildseqtype(Variable cdmvar)
protected void	buildseqtypes(Variable cdmvar) Walk this variable, including fields, to construct sequence types for any contained vlen dimensions
protected DapVariable	buildstringvar(Variable cdmvar)
protected DapVariable	buildstructvar(Variable cdmvar)
protected DapVariable	buildvariable(Variable cdmbasevar, DapNode parent, java.util.List<Dimension> cdmdims)
void	close()
protected NetcdfFile	createNetcdfFile(java.lang.String location, CancelTask canceltask)
protected long	dapsize(Dimension cdmdim)
boolean	dspMatch(java.lang.String path, DapContext context) Determine if a path refers to an object processable by this DSP
protected void	fillgroup(DapGroup dapgroup, Group cdmgroup)
protected Dimension	finddimdecl(Dimension dimref)
protected EnumTypedef	findMatchingEnum(EnumTypedef varenum) Unfortunately, the CDM Iosp does not actually use the declared enums.
NetcdfDataset	getNetcdfDataset()
DataCursor	getVariableData(DapVariable var)
protected boolean	isDimDeclFor(Dimension decl, Dimension ref)
CDMDSP	open(NetcdfDataset ncd) Provide an extra API for use in testing
CDMDSP	open(java.lang.String filepath) "open" a reference to a data source and return the DSP wrapper.
protected void	processmappedvariables(Group g)
protected void	recordNode(CDMNode cdm, DapNode dap) Track generic CDMNode <-> DapNode
protected void	recordSeq(Variable cdm, DapSequence dap) Track Variable <-> DapSequence
protected void	recordStruct(Variable cdm, DapStructure dap) Track Variable <-> DapStructure
protected void	recordVar(Variable cdm, DapVariable dap) Track Variable <-> DapVariable
protected boolean	shadows(Group parent, Group child)
protected boolean	suppress(java.lang.String attrname) Some attributes that are added by the NetcdfDataset need to be kept out of the DMR.
protected boolean	validatecdmtype(DataType datatype, java.lang.Class typeclass)

Methods inherited from class dap4.dap4lib.AbstractDSP

addVariableData, getChecksumMode, getContext, getDMR, getLocation, getOrder, parseDMR, printDMR, processAttributes, setChecksumMode, setContext, setDataset, setDMR, setLocation, setOrder

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

protected static final boolean DEBUG

See Also:

Constant Field Values

DUMPCDL

protected static final boolean DUMPCDL

See Also:

Constant Field Values

ENHANCEMENT

protected static java.util.Set<NetcdfDataset.Enhance> ENHANCEMENT

FILLVALUE

protected static final java.lang.String FILLVALUE

See Also:

Constant Field Values

nc4loaded

protected static boolean nc4loaded

ncdfile

protected NetcdfDataset ncdfile

closed

protected boolean closed

dmrfactory

protected DMRFactory dmrfactory

varmap

protected NodeMap<Variable,DapVariable> varmap

compoundmap

protected NodeMap<Variable,DapStructure> compoundmap

vlenmap

protected NodeMap<Variable,DapSequence> vlenmap

nodemap

protected NodeMap<CDMNode,DapNode> nodemap

Constructor Detail

CDMDSP

public CDMDSP()

CDMDSP

public CDMDSP(java.lang.String path)
       throws DapException

Throws:

DapException

Method Detail

dspMatch

public boolean dspMatch(java.lang.String path,
                        DapContext context)

Description copied from interface: DSP

Determine if a path refers to an object processable by this DSP

Returns:

true if this path can be processed by an instance of this DSP

open

public CDMDSP open(java.lang.String filepath)
            throws DapException

Description copied from class: AbstractDSP

"open" a reference to a data source and return the DSP wrapper.

Specified by:

open in interface DSP

Specified by:

open in class AbstractDSP

Parameters:

filepath - - absolute path to a file

Returns:

CDMDSP instance

Throws:

DapException

open

public CDMDSP open(NetcdfDataset ncd)
            throws DapException

Provide an extra API for use in testing

Parameters:

ncd - netcdf dataset

Returns:

the cdmdsp

Throws:

DapException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface DSP

Specified by:

close in class AbstractDSP

Throws:

java.io.IOException

getVariableData

public DataCursor getVariableData(DapVariable var)
                           throws DapException

Specified by:

getVariableData in interface DSP

Overrides:

getVariableData in class AbstractDSP

Throws:

DapException

getNetcdfDataset

public NetcdfDataset getNetcdfDataset()

recordNode

protected void recordNode(CDMNode cdm,
                          DapNode dap)

Track generic CDMNode <-> DapNode

recordVar

protected void recordVar(Variable cdm,
                         DapVariable dap)

Track Variable <-> DapVariable

recordStruct

protected void recordStruct(Variable cdm,
                            DapStructure dap)

Track Variable <-> DapStructure

recordSeq

protected void recordSeq(Variable cdm,
                         DapSequence dap)

Track Variable <-> DapSequence

buildDMR

public void buildDMR()
              throws DapException

Extract the metadata from the NetcdfDataset and build the DMR.

Throws:

DapException

fillgroup

protected void fillgroup(DapGroup dapgroup,
                         Group cdmgroup)
                  throws DapException

Throws:

DapException

builddim

protected DapDimension builddim(Dimension cdmdim)
                         throws DapException

Throws:

DapException

buildenum

protected DapEnumeration buildenum(EnumTypedef cdmenum)
                            throws DapException

Throws:

DapException

buildcompoundtype

protected DapStructure buildcompoundtype(Variable cdmvar,
                                         DapNode parent)
                                  throws DapException

Throws:

DapException

buildvariable

protected DapVariable buildvariable(Variable cdmbasevar,
                                    DapNode parent,
                                    java.util.List<Dimension> cdmdims)
                             throws DapException

Throws:

DapException

buildatomicvar

protected DapVariable buildatomicvar(Variable cdmvar,
                                     DapNode parent)
                              throws DapException

Throws:

DapException

buildopaquevar

protected DapVariable buildopaquevar(Variable cdmvar)
                              throws DapException

Throws:

DapException

buildstringvar

protected DapVariable buildstringvar(Variable cdmvar)
                              throws DapException

Throws:

DapException

buildenumvar

protected DapVariable buildenumvar(Variable cdmvar)
                            throws DapException

Throws:

DapException

buildstructvar

protected DapVariable buildstructvar(Variable cdmvar)
                              throws DapException

Throws:

DapException

buildseqtype

protected DapSequence buildseqtype(Variable cdmvar)
                            throws DapException

Throws:

DapException

buildseqtypes

protected void buildseqtypes(Variable cdmvar)
                      throws DapException

Walk this variable, including fields, to construct sequence types for any contained vlen dimensions

Parameters:

cdmvar - variable to walk

Throws:

DapException

buildattributes

protected void buildattributes(DapNode node,
                               AttributeContainer attributes)
                        throws DapException

Throws:

DapException

buildattribute

protected DapAttribute buildattribute(Attribute cdmattr)
                               throws DapException

Throws:

DapException

builddimrefs

protected void builddimrefs(DapVariable dapvar,
                            java.util.List<Dimension> cdmdims)
                     throws DapException

Assign dimensions to a variable

Parameters:

dapvar - The variable to which we wish to assign dimensions

cdmdims - The cdm dimensions from which we will find the dimension info

Throws:

DapException

processmappedvariables

protected void processmappedvariables(Group g)
                               throws DapException

Throws:

DapException

buildmaps

protected void buildmaps(DapVariable dapvar,
                         Variable var)
                  throws DapException

Parameters:

dapvar - The variable to which we wish to assign maps

var - The NetcdfDataset variable from which to extract coord system

Throws:

DapException

buildgroup

protected DapGroup buildgroup(Group cdmgroup)
                       throws DapException

Throws:

DapException

findMatchingEnum

protected EnumTypedef findMatchingEnum(EnumTypedef varenum)
                                throws DapException

Unfortunately, the CDM Iosp does not actually use the declared enums. Rather, for every enum type'd variable, a new enum decl is defined. So, we need to find the original enum decl that matches the variable's enum.

Throws:

DapException

shadows

protected boolean shadows(Group parent,
                          Group child)

dapsize

protected long dapsize(Dimension cdmdim)

validatecdmtype

protected boolean validatecdmtype(DataType datatype,
                                  java.lang.Class typeclass)

finddimdecl

protected Dimension finddimdecl(Dimension dimref)

isDimDeclFor

protected boolean isDimDeclFor(Dimension decl,
                               Dimension ref)

createNetcdfFile

protected NetcdfFile createNetcdfFile(java.lang.String location,
                                      CancelTask canceltask)
                               throws DapException

Throws:

DapException

suppress

protected boolean suppress(java.lang.String attrname)

Some attributes that are added by the NetcdfDataset need to be kept out of the DMR. This function defines that set.

Overrides:

suppress in class AbstractDSP

Parameters:

attrname - A non-escaped attribute name to be tested for suppression

Returns:

true if the attribute should be suppressed, false otherwise.

addToParent

protected void addToParent(DapNode parent,
                           DapVariable dapvar)
                    throws DapException

Throws:

DapException