dap4.cdm

Class CDMArraySequence

java.lang.Object

ucar.ma2.Array

ucar.ma2.ArrayStructure

ucar.ma2.ArraySequence

dap4.cdm.CDMArraySequence

All Implemented Interfaces:

CDMArray

public class CDMArraySequence
extends ArraySequence
implements CDMArray

CDM now has an ArraySequence type intended to support VLEN. So, sequence is simulated as a n+1 D structure where the last dimension is "*" (i.e. variable length). That is, given the following DAP4: Sequence S {f1,f2,...fm} [d1][d2]...[dn] Represent it in CDM as this: Structure S {f1,f2,...fm} [d1][d2]...[dn][*]

With respect to the data, the above is stored as an n-D array of ArrayObject instances where the leaf objects are instances of (CDM)ArraySequence.

Internally, the sequence stored as a 2-D ragged array CDMArray[][] records. The first dimension has varying lengths representing the (variable length) set of records in an instance of a Sequence. The second dimension has size |members| i.e. the number of fields in the sequence.

We cannot subclass CDMArrayStructure because we need to subclass ArraySequence, so we are forced to duplicate a lot of the CDMArrayStructure code.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CDMArraySequence.SDI

Nested classes/interfaces inherited from class ucar.ma2.ArrayStructure

ArrayStructure.ArrayStructureIterator

Field Summary

Fields

Modifier and Type	Field and Description
protected long	bytesize
protected D4DataSequence	d4data
protected D4DSP	dsp
protected long	nmembers
protected long	nrecords
protected Array[][]	records As mentioned above, we store an array of arrays of CDMArrays, where each CDMArray innstance represents a single record in some D4DataSequence object.
protected CDMDataset	root
protected DapVariable	template

Fields inherited from class ucar.ma2.ArraySequence

iter

Fields inherited from class ucar.ma2.ArrayStructure

members, nelems, sdata

Fields inherited from class ucar.ma2.Array

indexCalc, rank, unsigned

Method Summary

Modifier and Type	Method and Description
long	computeTotalSize()
Array	copy() DO NOT USE, throws UnsupportedOperationException
Array	getArray(int recno, StructureMembers.Member m) Get member data of any type for a specific record as an Array.
ArraySequence	getArraySequence(StructureMembers.Member m)
protected CDMArrayAtomic	getAtomicArray(int index, StructureMembers.Member m)
DapType	getBaseType()
long	getByteSize()
DSP	getDSP()
AtomicType	getPrimitiveType()
CDMDataset	getRoot()
long	getSizeBytes() Get the total number of bytes in the array.
StructureData	getStructureData(int index) Get the index'th StructureData(StructureDataA) object We need instances of StructureData to give to the user.
int	getStructureDataCount()
DapVariable	getTemplate()
protected StructureData	makeStructureData(ArrayStructure as, int index)
protected Array	memberArray(int recno, int memberindex)
java.lang.String	toString()

Methods inherited from class ucar.ma2.ArraySequence

extractMemberArray, getElementType, getStructureDataIterator, showInternal

Methods inherited from class ucar.ma2.ArrayStructure

convertScalarDouble, convertScalarFloat, convertScalarInt, convertScalarLong, copyBytes, copyChars, copyDoubles, copyFloats, copyFrom1DJavaArray, copyInts, copyLongs, copyObjects, copySequences, copyShorts, copyStructures, copyTo1DJavaArray, createView, findMember, getArrayObject, getArraySequence, getArrayStructure, getBoolean, getBoolean, getByte, getByte, getChar, getChar, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getJavaArrayByte, getJavaArrayChar, getJavaArrayDouble, getJavaArrayFloat, getJavaArrayInt, getJavaArrayLong, getJavaArrayShort, getJavaArrayString, getLong, getLong, getMembers, getObject, getObject, getScalarByte, getScalarChar, getScalarDouble, getScalarFloat, getScalarInt, getScalarLong, getScalarObject, getScalarShort, getScalarString, getScalarStructure, getShort, getShort, getStorage, getStructureData, getStructureMemberNames, getStructureMembers, getStructureSize, sectionNoReduce, setBoolean, setBoolean, setByte, setByte, setChar, setChar, setDouble, setDouble, setFloat, setFloat, setInt, setInt, setLong, setLong, setMemberArray, setObject, setObject, setShort, setShort, showInternalMembers

Methods inherited from class ucar.ma2.Array

arraycopy, copyTo1DJavaArray, copyToNDJavaArray, factory, factory, factory, factory, factory, factory, factoryConstant, flip, get1DJavaArray, getDataAsByteBuffer, getDataAsByteBuffer, getDataAsByteBuffer, getDataType, getIndex, getIndexIterator, getIndexIteratorFast, getIndexPrivate, getRangeIterator, getRank, getShape, getSize, hasNext, isConstant, isUnsigned, makeArray, makeArray, makeArray, makeArray, makeArrayRankPlusOne, next, nextBoolean, nextByte, nextChar, nextDouble, nextFloat, nextInt, nextLong, nextShort, permute, reduce, reduce, resetLocalIterator, reshape, reshapeNoCopy, section, section, section, sectionNoReduce, setUnsigned, shapeToString, slice, transpose

Methods inherited from class java.lang.Object

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

Field Detail

root

protected CDMDataset root

dsp

protected D4DSP dsp

template

protected DapVariable template

bytesize

protected long bytesize

d4data

protected D4DataSequence d4data

nmembers

protected long nmembers

records

protected Array[][] records

As mentioned above, we store an array of arrays of CDMArrays, where each CDMArray innstance represents a single record in some D4DataSequence object. Total number of objects is |records| * |members|, where |members| is the number of field members, and |records| is the total number of records in the sequence instance.

nrecords

protected long nrecords

Method Detail

getDSP

public DSP getDSP()

Specified by:

getDSP in interface CDMArray

getPrimitiveType

public AtomicType getPrimitiveType()

Specified by:

getPrimitiveType in interface CDMArray

getBaseType

public DapType getBaseType()

Specified by:

getBaseType in interface CDMArray

getRoot

public CDMDataset getRoot()

Specified by:

getRoot in interface CDMArray

getTemplate

public DapVariable getTemplate()

Specified by:

getTemplate in interface CDMArray

getByteSize

public long getByteSize()

Specified by:

getByteSize in interface CDMArray

toString

public java.lang.String toString()

Overrides:

toString in class ArraySequence

computeTotalSize

public long computeTotalSize()

getStructureDataCount

public int getStructureDataCount()

Overrides:

getStructureDataCount in class ArraySequence

getSizeBytes

public long getSizeBytes()

Description copied from class: Array

Get the total number of bytes in the array.

Overrides:

getSizeBytes in class ArraySequence

Returns:

total number of bytes in the array

makeStructureData

protected StructureData makeStructureData(ArrayStructure as,
                                          int index)

Overrides:

makeStructureData in class ArraySequence

getStructureData

public StructureData getStructureData(int index)

Get the index'th StructureData(StructureDataA) object We need instances of StructureData to give to the user. We use StructureDataA so we can centralize everything in this class. The total number of StructureData objects is dimsize.

Overrides:

getStructureData in class ArrayStructure

Parameters:

index -

Returns:

getArraySequence

public ArraySequence getArraySequence(StructureMembers.Member m)

copy

public Array copy()

Description copied from class: ArrayStructure

DO NOT USE, throws UnsupportedOperationException

Overrides:

copy in class ArrayStructure

Returns:

the new Array

getArray

public Array getArray(int recno,
                      StructureMembers.Member m)

Get member data of any type for a specific record as an Array. This may avoid the overhead of creating the StructureData object, but is equivalent to getStructure(recno).getArray( Member m).

Overrides:

getArray in class ArrayStructure

Parameters:

recno - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();

m - get data from this StructureMembers.Member.

Returns:

Array values.

getAtomicArray

protected CDMArrayAtomic getAtomicArray(int index,
                                        StructureMembers.Member m)

memberArray

protected Array memberArray(int recno,
                            int memberindex)