dap4.core.data

Interface DataCompoundArray

All Superinterfaces:

Data, DataVariable

All Known Implementing Classes:

D4DataCompoundArray

public interface DataCompoundArray
extends DataVariable

DataCompoundArray represents an array of either DataStructure or DataSequence instances. Note that is is NOT used for SCALARS.

Method Summary

Modifier and Type	Method and Description
long	getCount() Get the total number of elements in the variable array.
DataSort	getElementSort() Get the element sort; currently returns only DataSort.{SEQUENCE,STRUCTURE}
void	read(java.util.List<Slice> constraint, DataCompound[] data) Read multiple values at once.
DataCompound	read(long index) Provide a read of a single value at a given index in a variable.

Methods inherited from interface dap4.core.data.DataVariable

getVariable

Methods inherited from interface dap4.core.data.Data

getSort, getTemplate

Method Detail

getElementSort

DataSort getElementSort()

Get the element sort; currently returns only DataSort.{SEQUENCE,STRUCTURE}

Returns:

sort

getCount

long getCount()

Get the total number of elements in the variable 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.

read

void read(java.util.List<Slice> constraint,
          DataCompound[] data)
   throws DataException

Read multiple values at once. The returned value (parameter "data") is some form of array of DataCompound objects.

Parameters:

constraint - slices constraining what is to be returned.

data - the array into which the values are returned

Throws:

DataException

read

DataCompound read(long index)
           throws DataException

Provide a read of a single value at a given index in a variable.

Parameters:

index - of the value to read.

Throws:

DataException