Package dap4.dap4lib

Class AbstractDSP

java.lang.Object

dap4.dap4lib.AbstractDSP

All Implemented Interfaces:

dap4.core.data.DSP

Direct Known Subclasses:

D4DSP, Nc4DSP

public abstract class AbstractDSP
extends Object
implements dap4.core.data.DSP

Provide a superclass for DSPs.

Field Summary

Fields

Modifier and Type	Field	Description
protected dap4.core.util.DapContext	context
protected static String	DAPVERSION
protected static boolean	DEBUG
protected dap4.core.dmr.DapDataset	dmr
protected static String	DMRNS
protected static String	DMRVERSION
protected String	location
protected static boolean	PARSEDEBUG
protected dap4.core.data.DataCursor	rootcursor
static boolean	TESTING
static String	UCARTAGOPAQUE
static String	UCARTAGORIGTYPE
static String	UCARTAGUNLIMITED
static String	UCARTAGVLEN
static boolean	USEDOM
protected Map<dap4.core.dmr.DapVariable,dap4.core.data.DataCursor>	variables

Constructor Summary

Constructors

Constructor	Description
AbstractDSP()

Method Summary

Modifier and Type	Method	Description
void	addVariableData(dap4.core.dmr.DapVariable var, dap4.core.data.DataCursor cursor)
abstract void	close()
dap4.core.data.ChecksumMode	getChecksumMode()
dap4.core.util.DapContext	getContext()
dap4.core.dmr.DapDataset	getDMR()
String	getLocation()
ByteOrder	getOrder()
dap4.core.data.DataCursor	getVariableData(dap4.core.dmr.DapVariable var)
abstract AbstractDSP	open(String location)	"open" a reference to a data source and return the DSP wrapper.
protected dap4.core.dmr.DapDataset	parseDMR(String document)	It is common to want to parse a DMR text to a DapDataset, so provide this utility.
static String	printDMR(dap4.core.dmr.DapDataset dmr)
protected void	processAttributes(dap4.core.dmr.DapDataset dataset)	Walk the dataset tree and remove selected attributes such as _Unsigned
AbstractDSP	setChecksumMode(dap4.core.data.ChecksumMode mode)
void	setContext(dap4.core.util.DapContext context)
protected void	setDataset(dap4.core.dmr.DapDataset dataset)
void	setDMR(dap4.core.dmr.DapDataset dmr)
AbstractDSP	setLocation(String loc)
AbstractDSP	setOrder(ByteOrder order)
protected boolean	suppress(String attrname)	Some attributes that are added by the NetcdfDataset need to be kept out of the DMR.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dap4.core.data.DSP

dspMatch

Field Detail

TESTING

public static boolean TESTING

DEBUG

protected static final boolean DEBUG

See Also:

Constant Field Values

PARSEDEBUG

protected static final boolean PARSEDEBUG

See Also:

Constant Field Values

USEDOM

public static final boolean USEDOM

See Also:

Constant Field Values

DAPVERSION

protected static final String DAPVERSION

See Also:

Constant Field Values

DMRVERSION

protected static final String DMRVERSION

See Also:

Constant Field Values

DMRNS

protected static final String DMRNS

See Also:

Constant Field Values

UCARTAGVLEN

public static final String UCARTAGVLEN

See Also:

Constant Field Values

UCARTAGOPAQUE

public static final String UCARTAGOPAQUE

See Also:

Constant Field Values

UCARTAGORIGTYPE

public static final String UCARTAGORIGTYPE

See Also:

Constant Field Values

UCARTAGUNLIMITED

public static final String UCARTAGUNLIMITED

See Also:

Constant Field Values

context

protected dap4.core.util.DapContext context

dmr

protected dap4.core.dmr.DapDataset dmr

location

protected String location

variables

protected Map<dap4.core.dmr.DapVariable,dap4.core.data.DataCursor> variables

rootcursor

protected dap4.core.data.DataCursor rootcursor

Constructor Detail

AbstractDSP

public AbstractDSP()

Method Detail

open

public abstract AbstractDSP open(String location)
                          throws dap4.core.util.DapException

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

Specified by:

open in interface dap4.core.data.DSP

Parameters:

location - - Object that defines the data source

Returns:

= wrapping dsp

Throws:

dap4.core.util.DapException

close

public abstract void close()
                    throws IOException

Specified by:

close in interface dap4.core.data.DSP

Throws:

IOException

getVariableData

public dap4.core.data.DataCursor getVariableData(dap4.core.dmr.DapVariable var)
                                          throws dap4.core.util.DapException

Specified by:

getVariableData in interface dap4.core.data.DSP

Throws:

dap4.core.util.DapException

getContext

public dap4.core.util.DapContext getContext()

Specified by:

getContext in interface dap4.core.data.DSP

getLocation

public String getLocation()

Specified by:

getLocation in interface dap4.core.data.DSP

setLocation

public AbstractDSP setLocation(String loc)

Specified by:

setLocation in interface dap4.core.data.DSP

getDMR

public dap4.core.dmr.DapDataset getDMR()

Specified by:

getDMR in interface dap4.core.data.DSP

setContext

public void setContext(dap4.core.util.DapContext context)

Specified by:

setContext in interface dap4.core.data.DSP

setDMR

public void setDMR(dap4.core.dmr.DapDataset dmr)

setDataset

protected void setDataset(dap4.core.dmr.DapDataset dataset)
                   throws dap4.core.util.DapException

Throws:

dap4.core.util.DapException

getOrder

public ByteOrder getOrder()

Specified by:

getOrder in interface dap4.core.data.DSP

setOrder

public AbstractDSP setOrder(ByteOrder order)

getChecksumMode

public dap4.core.data.ChecksumMode getChecksumMode()

Specified by:

getChecksumMode in interface dap4.core.data.DSP

setChecksumMode

public AbstractDSP setChecksumMode(dap4.core.data.ChecksumMode mode)

addVariableData

public void addVariableData(dap4.core.dmr.DapVariable var,
                            dap4.core.data.DataCursor cursor)

parseDMR

protected dap4.core.dmr.DapDataset parseDMR(String document)
                                     throws dap4.core.util.DapException

It is common to want to parse a DMR text to a DapDataset, so provide this utility.

Parameters:

document - the dmr to parse

Returns:

the parsed dmr

Throws:

dap4.core.util.DapException - on parse errors

processAttributes

protected void processAttributes(dap4.core.dmr.DapDataset dataset)
                          throws dap4.core.util.DapException

Walk the dataset tree and remove selected attributes such as _Unsigned

Parameters:

dataset -

Throws:

dap4.core.util.DapException

suppress

protected boolean suppress(String attrname)

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

Parameters:

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

Returns:

true if the attribute should be suppressed, false otherwise.

printDMR

public static String printDMR(dap4.core.dmr.DapDataset dmr)