dap4.servlet

Class CDMDSP

java.lang.Object

dap4.dap4shared.AbstractDSP

dap4.servlet.CDMDSP

All Implemented Interfaces:

dap4.dap4shared.DSP

public class CDMDSP
extends dap4.dap4shared.AbstractDSP

CDM->DAP DSP

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed
protected static java.lang.String	DAPVERSION
protected CDMDataDataset	data
protected static boolean	DEBUG
protected static java.lang.String	DMRVERSION
protected static java.util.Set<ucar.nc2.dataset.NetcdfDataset.Enhance>	ENHANCEMENT
protected dap4.core.dmr.DapFactory	factory
protected static java.lang.Object	FACTORYKEY
protected static java.lang.Class	NC4CLASS
protected static boolean	nc4loaded
protected ucar.nc2.dataset.NetcdfDataset	ncdfile
protected dap4.cdmshared.NodeMap	nodemap
protected javax.servlet.http.HttpServletRequest	request
protected javax.servlet.http.HttpServletResponse	response

Fields inherited from class dap4.dap4shared.AbstractDSP

context, dmr, PARSEDEBUG, path

Constructor Summary

Constructors

Constructor and Description
CDMDSP()
CDMDSP(ucar.nc2.NetcdfFile ncd, dap4.core.util.DapContext cxt)
CDMDSP(java.lang.String path, dap4.core.util.DapContext cxt)

Method Summary

Modifier and Type	Method and Description
void	build() Extract the metadata from the NetcdfDataset and build the DMR.
protected dap4.core.dmr.DapAtomicVariable	buildatomicvar(ucar.nc2.Variable cdmvar)
protected dap4.core.dmr.DapAttribute	buildattribute(ucar.nc2.Attribute attr)
protected void	buildattributes(dap4.core.dmr.DapNode node, java.util.List<ucar.nc2.Attribute> attributes)
protected dap4.core.data.DataVariable	buildData(dap4.core.dmr.DapVariable dap)
protected dap4.core.data.DataDataset	buildDataDataset() Build a tree of Data objects corresponding to the DMR.
protected dap4.core.dmr.DapDimension	builddim(ucar.nc2.Dimension cdmdim)
protected void	builddimrefs(dap4.core.dmr.DapVariable dapvar, java.util.List<ucar.nc2.Dimension> cdmdims) Assign dimensions to a variable
protected dap4.core.dmr.DapEnum	buildenum(ucar.nc2.EnumTypedef cdmenum)
protected dap4.core.dmr.DapAtomicVariable	buildenumvar(ucar.nc2.Variable cdmvar)
protected dap4.core.dmr.DapGroup	buildgroup(ucar.nc2.Group cdmgroup)
protected void	buildmaps(dap4.core.dmr.DapVariable dapvar, ucar.nc2.Variable var)
protected dap4.core.dmr.DapAtomicVariable	buildopaquevar(ucar.nc2.Variable cdmvar)
protected dap4.core.dmr.DapSequence	buildsequence(ucar.nc2.Variable cdmbasevar)
protected dap4.core.dmr.DapAtomicVariable	buildstringvar(ucar.nc2.Variable cdmvar)
protected dap4.core.dmr.DapStructure	buildstructvar(ucar.nc2.Variable cdmvar)
protected dap4.core.dmr.DapNode	buildvariable(ucar.nc2.Variable cdmvar, dap4.core.dmr.DapNode parent)
protected dap4.core.dmr.DapNode	buildvariable(ucar.nc2.Variable cdmbasevar, java.util.List<ucar.nc2.Dimension> cdmdims, dap4.core.dmr.DapNode parent)
void	close()
protected ucar.nc2.NetcdfFile	createNetcdfFile(java.lang.String location, ucar.nc2.util.CancelTask canceltask)
protected long	dapsize(ucar.nc2.Dimension cdmdim)
protected void	fillgroup(dap4.core.dmr.DapGroup dapgroup, ucar.nc2.Group cdmgroup)
protected ucar.nc2.Dimension	finddimdecl(ucar.nc2.Dimension dimref)
protected ucar.nc2.EnumTypedef	findMatchingEnum(ucar.nc2.EnumTypedef varenum) Unfortunately, the CDM Iosp does not actually use the declared enums.
protected java.lang.Object	fixvalue(java.lang.Object o, dap4.core.dmr.DapType datatype)
ucar.nc2.CDMNode	getCDMNode(dap4.core.dmr.DapNode dapnode) Lookup a dapnode in the dap nodemap.
dap4.core.data.DataDataset	getDataDataset()
ucar.nc2.dataset.NetcdfDataset	getNetcdfDataset()
protected void	init(ucar.nc2.NetcdfFile ncfile)
protected boolean	isdeclfor(ucar.nc2.Dimension decl, ucar.nc2.Dimension ref)
static void	loadNc4Iosp() Make sure that NC4Iosp is registered and library loaded
protected dap4.core.dmr.DapNode	lookupNode(ucar.nc2.CDMNode cdmnode) Lookup a cdmnode in the cdmnodemap.
static boolean	match(java.lang.String path, dap4.core.util.DapContext context)
protected dap4.core.dmr.DapNode	newNode(dap4.core.util.DapSort sort)
dap4.dap4shared.DSP	open(java.lang.String path)
dap4.dap4shared.DSP	open(java.lang.String path, dap4.core.util.DapContext context)
protected void	processmappedvariables(ucar.nc2.Group g)
protected void	recordNode(ucar.nc2.CDMNode cdmnode, dap4.core.dmr.DapNode dapnode) Record a cdmnode+dapnode in the nodemap.
void	setDataDataset(CDMDataDataset data)
protected void	setRequestResponse()
protected boolean	shadows(ucar.nc2.Group parent, ucar.nc2.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(ucar.ma2.DataType datatype, boolean unsigned, java.lang.Class typeclass)

Methods inherited from class dap4.dap4shared.AbstractDSP

getContext, getDMR, getPath, parseDMR, processAttributes, setContext, setDataset, setPath

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

FACTORYKEY

protected static final java.lang.Object FACTORYKEY

DAPVERSION

protected static final java.lang.String DAPVERSION

See Also:

Constant Field Values

DMRVERSION

protected static final java.lang.String DMRVERSION

See Also:

Constant Field Values

NC4CLASS

protected static final java.lang.Class NC4CLASS

ENHANCEMENT

protected static java.util.Set<ucar.nc2.dataset.NetcdfDataset.Enhance> ENHANCEMENT

nc4loaded

protected static boolean nc4loaded

ncdfile

protected ucar.nc2.dataset.NetcdfDataset ncdfile

factory

protected dap4.core.dmr.DapFactory factory

nodemap

protected dap4.cdmshared.NodeMap nodemap

closed

protected boolean closed

data

protected CDMDataDataset data

request

protected javax.servlet.http.HttpServletRequest request

response

protected javax.servlet.http.HttpServletResponse response

Constructor Detail

CDMDSP

public CDMDSP()

CDMDSP

public CDMDSP(java.lang.String path,
              dap4.core.util.DapContext cxt)
       throws dap4.core.util.DapException

Throws:

dap4.core.util.DapException

CDMDSP

public CDMDSP(ucar.nc2.NetcdfFile ncd,
              dap4.core.util.DapContext cxt)
       throws dap4.core.util.DapException

Throws:

dap4.core.util.DapException

Method Detail

loadNc4Iosp

public static void loadNc4Iosp()
                        throws dap4.core.util.DapException

Make sure that NC4Iosp is registered and library loaded

Throws:

dap4.core.util.DapException

init

protected void init(ucar.nc2.NetcdfFile ncfile)
             throws dap4.core.util.DapException

Throws:

dap4.core.util.DapException

setRequestResponse

protected void setRequestResponse()

Overrides:

setRequestResponse in class dap4.dap4shared.AbstractDSP

match

public static boolean match(java.lang.String path,
                            dap4.core.util.DapContext context)

open

public dap4.dap4shared.DSP open(java.lang.String path)
                         throws dap4.core.util.DapException

Specified by:

open in interface dap4.dap4shared.DSP

Overrides:

open in class dap4.dap4shared.AbstractDSP

Throws:

dap4.core.util.DapException

open

public dap4.dap4shared.DSP open(java.lang.String path,
                                dap4.core.util.DapContext context)
                         throws dap4.core.util.DapException

Specified by:

open in interface dap4.dap4shared.DSP

Specified by:

open in class dap4.dap4shared.AbstractDSP

Throws:

dap4.core.util.DapException

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException

getDataDataset

public dap4.core.data.DataDataset getDataDataset()

Specified by:

getDataDataset in interface dap4.dap4shared.DSP

Specified by:

getDataDataset in class dap4.dap4shared.AbstractDSP

getNetcdfDataset

public ucar.nc2.dataset.NetcdfDataset getNetcdfDataset()

setDataDataset

public void setDataDataset(CDMDataDataset data)

getCDMNode

public ucar.nc2.CDMNode getCDMNode(dap4.core.dmr.DapNode dapnode)

Lookup a dapnode in the dap nodemap.

Parameters:

dapnode - The DapNode

Returns:

The corresponding CDMNode or null

recordNode

protected void recordNode(ucar.nc2.CDMNode cdmnode,
                          dap4.core.dmr.DapNode dapnode)

Record a cdmnode+dapnode in the nodemap. Make sure that we use the proper object in order to avoid identity problems.

Parameters:

cdmnode - The CMDNode (variable, dimension, etc) to record

dapnode - The DapNode to which the cdmnode is to be mapped.

lookupNode

protected dap4.core.dmr.DapNode lookupNode(ucar.nc2.CDMNode cdmnode)

Lookup a cdmnode in the cdmnodemap. Make sure that we use the proper object in order to avoid identity problems.

Parameters:

cdmnode - The CMDNode (variable, dimension, etc) to record

Returns:

The DapNode to which the cdmnode is to be mapped or null.

build

public void build()
           throws dap4.core.util.DapException

Extract the metadata from the NetcdfDataset and build the DMR.

Throws:

dap4.core.util.DapException

fillgroup

protected void fillgroup(dap4.core.dmr.DapGroup dapgroup,
                         ucar.nc2.Group cdmgroup)
                  throws dap4.core.util.DapException

Throws:

dap4.core.util.DapException

builddim

protected dap4.core.dmr.DapDimension builddim(ucar.nc2.Dimension cdmdim)
                                       throws dap4.core.util.DapException

Throws:

dap4.core.util.DapException

buildenum

protected dap4.core.dmr.DapEnum buildenum(ucar.nc2.EnumTypedef cdmenum)
                                   throws dap4.core.util.DapException

Throws:

dap4.core.util.DapException

buildvariable

protected dap4.core.dmr.DapNode buildvariable(ucar.nc2.Variable cdmvar,
                                              dap4.core.dmr.DapNode parent)
                                       throws dap4.core.util.DapException

Throws:

dap4.core.util.DapException

buildvariable

protected dap4.core.dmr.DapNode buildvariable(ucar.nc2.Variable cdmbasevar,
                                              java.util.List<ucar.nc2.Dimension> cdmdims,
                                              dap4.core.dmr.DapNode parent)
                                       throws dap4.core.util.DapException

Throws:

dap4.core.util.DapException

buildatomicvar

protected dap4.core.dmr.DapAtomicVariable buildatomicvar(ucar.nc2.Variable cdmvar)
                                                  throws dap4.core.util.DapException

Throws:

dap4.core.util.DapException

buildopaquevar

protected dap4.core.dmr.DapAtomicVariable buildopaquevar(ucar.nc2.Variable cdmvar)
                                                  throws dap4.core.util.DapException

Throws:

dap4.core.util.DapException

buildstringvar

protected dap4.core.dmr.DapAtomicVariable buildstringvar(ucar.nc2.Variable cdmvar)
                                                  throws dap4.core.util.DapException

Throws:

dap4.core.util.DapException

buildenumvar

protected dap4.core.dmr.DapAtomicVariable buildenumvar(ucar.nc2.Variable cdmvar)
                                                throws dap4.core.util.DapException

Throws:

dap4.core.util.DapException

findMatchingEnum

protected ucar.nc2.EnumTypedef findMatchingEnum(ucar.nc2.EnumTypedef varenum)
                                         throws dap4.core.util.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:

dap4.core.util.DapException

shadows

protected boolean shadows(ucar.nc2.Group parent,
                          ucar.nc2.Group child)

buildstructvar

protected dap4.core.dmr.DapStructure buildstructvar(ucar.nc2.Variable cdmvar)
                                             throws dap4.core.util.DapException

Throws:

dap4.core.util.DapException

buildsequence

protected dap4.core.dmr.DapSequence buildsequence(ucar.nc2.Variable cdmbasevar)
                                           throws dap4.core.util.DapException

Throws:

dap4.core.util.DapException

buildattributes

protected void buildattributes(dap4.core.dmr.DapNode node,
                               java.util.List<ucar.nc2.Attribute> attributes)
                        throws dap4.core.util.DapException

Throws:

dap4.core.util.DapException

buildattribute

protected dap4.core.dmr.DapAttribute buildattribute(ucar.nc2.Attribute attr)
                                             throws dap4.core.util.DapException

Throws:

dap4.core.util.DapException

builddimrefs

protected void builddimrefs(dap4.core.dmr.DapVariable dapvar,
                            java.util.List<ucar.nc2.Dimension> cdmdims)
                     throws dap4.core.util.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:

dap4.core.util.DapException

processmappedvariables

protected void processmappedvariables(ucar.nc2.Group g)
                               throws dap4.core.util.DapException

Throws:

dap4.core.util.DapException

buildmaps

protected void buildmaps(dap4.core.dmr.DapVariable dapvar,
                         ucar.nc2.Variable var)
                  throws dap4.core.util.DapException

Parameters:

dapvar - The variable to which we wish to assign maps

var - The NetcdfDataset variable from which to extract coord system

Throws:

dap4.core.util.DapException

buildgroup

protected dap4.core.dmr.DapGroup buildgroup(ucar.nc2.Group cdmgroup)
                                     throws dap4.core.util.DapException

Throws:

dap4.core.util.DapException

newNode

protected dap4.core.dmr.DapNode newNode(dap4.core.util.DapSort sort)

dapsize

protected long dapsize(ucar.nc2.Dimension cdmdim)

validatecdmtype

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

finddimdecl

protected ucar.nc2.Dimension finddimdecl(ucar.nc2.Dimension dimref)

isdeclfor

protected boolean isdeclfor(ucar.nc2.Dimension decl,
                            ucar.nc2.Dimension ref)

fixvalue

protected java.lang.Object fixvalue(java.lang.Object o,
                                    dap4.core.dmr.DapType datatype)

buildDataDataset

protected dap4.core.data.DataDataset buildDataDataset()
                                               throws dap4.core.data.DataException

Build a tree of Data objects corresponding to the DMR.

Throws:

dap4.core.data.DataException

buildData

protected dap4.core.data.DataVariable buildData(dap4.core.dmr.DapVariable dap)
                                         throws dap4.core.data.DataException

Throws:

dap4.core.data.DataException

createNetcdfFile

protected ucar.nc2.NetcdfFile createNetcdfFile(java.lang.String location,
                                               ucar.nc2.util.CancelTask canceltask)
                                        throws dap4.core.util.DapException

Throws:

dap4.core.util.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 dap4.dap4shared.AbstractDSP

Parameters:

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

Returns:

true if the attribute should be suppressed, false otherwise.