dap4.core.data

Interface DataAtomic

All Superinterfaces:

Data, DataVariable

All Known Implementing Classes:

D4DataAtomic

public interface DataAtomic
extends DataVariable

DataAtomic represents a non-container object.

Method Summary

Modifier and Type	Method and Description
long	getCount() Get the total number of elements in the atomic array.
long	getElementSize() Get the s ize of a single element in bytes; 0 => undefined
DapType	getType() Get the type of this atomic variable
void	read(java.util.List<Slice> constraint, java.lang.Object data, long offset) Read of multiple values at once.
java.lang.Object	read(long index) Provide a read of a single value at a given offset in a (possibly dimensioned) atomic valued variable.

Methods inherited from interface dap4.core.data.DataVariable

getVariable

Methods inherited from interface dap4.core.data.Data

getSort, getTemplate

Method Detail

getType

DapType getType()

Get the type of this atomic variable

Returns:

the type

getCount

long getCount()

Get the total number of elements in the atomic array. A scalar is treated as a one element array.

Returns:

1 if the variable is scalar, else the product of the dimensions of the variable.

getElementSize

long getElementSize()

Get the s ize of a single element in bytes; 0 => undefined

Returns:

size

read

void read(java.util.List<Slice> constraint,
          java.lang.Object data,
          long offset)
   throws DataException

Read of multiple values at once. The returned value (parameter "data") is some form of java array (e.g. int[]). The type depends on the value of getType(). Note that implementations of this interface are free to provide alternate read methods that return values in e.g. a java.nio.Buffer. Note that unsigned types (e.g. UInt64) are returned as a signed version (e.g. Int64), and will have the proper bit pattern for the unsigned value. If the size of the "data" array is not the correct size, then an error will be returned. For opaque data, the result is ByteBuffer[].

Parameters:

constraint - the set of slices defining which values to return

data - the array into which the values are returned

offset - the offset into data into which to read

Throws:

DataException

read

java.lang.Object read(long index)
               throws DataException

Provide a read of a single value at a given offset in a (possibly dimensioned) atomic valued variable. As mentioned above, unsigned types are returned as a signed version. The type of the returned value is the obvious one (e.g. int->Integer, opaque->ByteBuffer, etc.).

Throws:

DataException