CDMArrayStructure (All javadoc for netcdf-java version 4.6.22-SNAPSHOT)

java.lang.Object
- ucar.ma2.Array
- - ucar.ma2.ArrayStructure
  - - dap4.cdm.CDMArrayStructure

All Implemented Interfaces:

CDMArray
```
public class CDMArrayStructure
extends ArrayStructure
implements CDMArray
```
Implementation of ArrayStructure that wraps DAP4 databuffer (Note: Needs serious optimization applied).
Given Structure S {f1,f2,...fm} [d1][d2]...[dn], internally, this is stored as a 2-D array CDMArray[][] instances; The first dimension's length is d1*d2*...dn. The second dimension has size |members| i.e. the number of fields in the sequence.

Nested Class Summary
- Nested classes/interfaces inherited from class ucar.ma2.ArrayStructure
  ArrayStructure.ArrayStructureIterator

Field Summary

Fields
Modifier and Type	Field and Description
`protected DapType`	`basetype`
`protected long`	`bytesize`
`protected D4DataCompoundArray`	`d4data`
`protected long`	`dimsize`
`protected D4DSP`	`dsp`
`protected Array[][]`	`instances` Since we are using StructureData, we do not actually need to keep the D4DataStructure instances as such.
`protected long`	`nmembers`
`protected AtomicType`	`primitivetype`
`protected CDMDataset`	`root`
`protected DapVariable`	`template`

Fields inherited from class ucar.ma2.ArrayStructure
members, nelems, sdata

Fields inherited from class ucar.ma2.Array
indexCalc, rank, unsigned

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`computeTotalSize()`
`Array`	`copy()` DO NOT USE, throws UnsupportedOperationException
`Array`	`getArray(int recno, StructureMembers.Member m)` Key interface method coming in from StructureDataA.
`ArraySequence`	`getArraySequence(StructureMembers.Member m)`
`ArrayStructure`	`getArrayStructure(int index, StructureMembers.Member m)` Get member data of type array of Structure.
`protected CDMArrayAtomic`	`getAtomicArray(int index, StructureMembers.Member m)`
`DapType`	`getBaseType()`
`long`	`getByteSize()`
`DSP`	`getDSP()`
`byte[]`	`getJavaArrayByte(int index, StructureMembers.Member m)` Get member data of type byte as a 1D array.
`char[]`	`getJavaArrayChar(int index, StructureMembers.Member m)` Get member data of type char as a 1D array.
`double[]`	`getJavaArrayDouble(int recnum, StructureMembers.Member m)` Get member data of type double as a 1D array.
`float[]`	`getJavaArrayFloat(int index, StructureMembers.Member m)` Get member data of type float as a 1D array.
`int[]`	`getJavaArrayInt(int index, StructureMembers.Member m)` Get member data of type int as a 1D array.
`long[]`	`getJavaArrayLong(int index, StructureMembers.Member m)` Get member data of type long as a 1D array.
`java.nio.ByteBuffer[]`	`getJavaArrayOpaque(int index, StructureMembers.Member m)`
`short[]`	`getJavaArrayShort(int index, StructureMembers.Member m)` Get member data of type short as a 1D array.
`java.lang.String[]`	`getJavaArrayString(int index, StructureMembers.Member m)` Get member data of type String as a 1D array.
`AtomicType`	`getPrimitiveType()`
`CDMDataset`	`getRoot()`
`byte`	`getScalarByte(int index, StructureMembers.Member m)` Get scalar member data of type byte.
`char`	`getScalarChar(int index, StructureMembers.Member m)` Get scalar member data of type char.
`double`	`getScalarDouble(int index, StructureMembers.Member m)` Get scalar member data of type double.
`float`	`getScalarFloat(int index, StructureMembers.Member m)` Get scalar member data of type float.
`int`	`getScalarInt(int index, StructureMembers.Member m)` Get scalar member data of type int.
`long`	`getScalarLong(int index, StructureMembers.Member m)` Get scalar member data of type long.
`short`	`getScalarShort(int index, StructureMembers.Member m)` Get scalar member data of type short.
`java.lang.String`	`getScalarString(int recnum, StructureMembers.Member m)` Get member databuffer of type String or char.
`StructureData`	`getScalarStructure(int index, StructureMembers.Member m)` Get member data of type Structure.
`long`	`getSize()` Get the total number of elements in the array.
`StructureData`	`getStructureData(int index)` Get the index'th StructureData(StructureDataA) object We need instances of StructureData to give to the user.
`DapVariable`	`getTemplate()`
`protected StructureData`	`makeStructureData(ArrayStructure as, int index)`
`protected Array`	`memberArray(int recno, int memberindex)`
`protected static int`	`memberIndex(StructureMembers.Member m)`
`java.lang.String`	`toString()`

Methods inherited from class ucar.ma2.ArrayStructure
convertScalarDouble, convertScalarFloat, convertScalarInt, convertScalarLong, copyBytes, copyChars, copyDoubles, copyFloats, copyFrom1DJavaArray, copyInts, copyLongs, copyObjects, copySequences, copyShorts, copyStructures, copyTo1DJavaArray, createView, extractMemberArray, findMember, getArrayObject, getArraySequence, getBoolean, getBoolean, getByte, getByte, getChar, getChar, getDouble, getDouble, getElementType, getFloat, getFloat, getInt, getInt, getLong, getLong, getMembers, getObject, getObject, getScalarObject, getShort, getShort, getSizeBytes, getStorage, getStructureData, getStructureDataIterator, getStructureMemberNames, getStructureMembers, getStructureSize, sectionNoReduce, setBoolean, setBoolean, setByte, setByte, setChar, setChar, setDouble, setDouble, setFloat, setFloat, setInt, setInt, setLong, setLong, setMemberArray, setObject, setObject, setShort, setShort, showInternal, 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, 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
```
  - basetype
```
protected DapType basetype
```
  - primitivetype
```
protected AtomicType primitivetype
```
  - d4data
```
protected D4DataCompoundArray d4data
```
  - dimsize
```
protected long dimsize
```
  - nmembers
```
protected long nmembers
```
  - instances
```
protected Array[][] instances
```
    Since we are using StructureData, we do not actually need to keep the D4DataStructure instances as such. We need a mapping from index X member to a CDMArray object. Total number of objects is dimsize * |members|. Accessed by StructureData.
- Method Detail
  - getDSP
```
public DSP getDSP()
```
    Specified by:
    
    getDSP 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
  - getBaseType
```
public DapType getBaseType()
```
    Specified by:
    
    getBaseType in interface CDMArray
  - getPrimitiveType
```
public AtomicType getPrimitiveType()
```
    Specified by:
    
    getPrimitiveType in interface CDMArray
  - getSize
```
public long getSize()
```
    Description copied from class: Array
    
    Get the total number of elements in the array.
    
    Overrides:
    
    getSize in class Array
    
    Returns:
    
    total number of elements in the array
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class Array
  - computeTotalSize
```
public long computeTotalSize()
```
  - 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:
  - getArray
```
public Array getArray(int recno,
                      StructureMembers.Member m)
```
    Key interface method coming in from StructureDataA.
    
    Overrides:
    
    getArray in class ArrayStructure
    
    Parameters:
    
    recno - The instance # of the array of Structure instances
    
    m - The member of interest in the Structure instance
    
    Returns:
    
    The ucar.ma2.Array instance corresponding to the instance.
  - getScalarDouble
```
public double getScalarDouble(int index,
                              StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get scalar member data of type double.
    
    Overrides:
    
    getScalarDouble in class ArrayStructure
    
    Parameters:
    
    index - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - get data from this StructureMembers.Member. Must be of type double.
    
    Returns:
    
    scalar double value
  - getScalarFloat
```
public float getScalarFloat(int index,
                            StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get scalar member data of type float.
    
    Overrides:
    
    getScalarFloat in class ArrayStructure
    
    Parameters:
    
    index - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - get data from this StructureMembers.Member. Must be of type float.
    
    Returns:
    
    scalar double value
  - getScalarByte
```
public byte getScalarByte(int index,
                          StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get scalar member data of type byte.
    
    Overrides:
    
    getScalarByte in class ArrayStructure
    
    Parameters:
    
    index - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - get data from this StructureMembers.Member. Must be of type byte.
    
    Returns:
    
    scalar double value
  - getScalarShort
```
public short getScalarShort(int index,
                            StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get scalar member data of type short.
    
    Overrides:
    
    getScalarShort in class ArrayStructure
    
    Parameters:
    
    index - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - get data from this StructureMembers.Member. Must be of type short.
    
    Returns:
    
    scalar double value
  - getScalarInt
```
public int getScalarInt(int index,
                        StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get scalar member data of type int.
    
    Overrides:
    
    getScalarInt in class ArrayStructure
    
    Parameters:
    
    index - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - get data from this StructureMembers.Member. Must be of type int.
    
    Returns:
    
    scalar double value
  - getScalarLong
```
public long getScalarLong(int index,
                          StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get scalar member data of type long.
    
    Overrides:
    
    getScalarLong in class ArrayStructure
    
    Parameters:
    
    index - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - get data from this StructureMembers.Member. Must be of type long.
    
    Returns:
    
    scalar double value
  - getScalarChar
```
public char getScalarChar(int index,
                          StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get scalar member data of type char.
    
    Overrides:
    
    getScalarChar in class ArrayStructure
    
    Parameters:
    
    index - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - get data from this StructureMembers.Member. Must be of type char.
    
    Returns:
    
    scalar double value
  - getScalarString
```
public java.lang.String getScalarString(int recnum,
                                        StructureMembers.Member m)
```
    Get member databuffer of type String or char.
    
    Overrides:
    
    getScalarString in class ArrayStructure
    
    Parameters:
    
    recnum - get databuffer from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - get databuffer from this StructureMembers.Member. Must be of type String or char.
    
    Returns:
    
    scalar String value
  - getJavaArrayDouble
```
public double[] getJavaArrayDouble(int recnum,
                                   StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get member data of type double as a 1D array. The member data may be any rank.
    
    Overrides:
    
    getJavaArrayDouble in class ArrayStructure
    
    Parameters:
    
    recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - get data from this StructureMembers.Member. Must be of type double.
    
    Returns:
    
    double[]
  - getJavaArrayFloat
```
public float[] getJavaArrayFloat(int index,
                                 StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get member data of type float as a 1D array.
    
    Overrides:
    
    getJavaArrayFloat in class ArrayStructure
    
    Parameters:
    
    index - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - get data from this StructureMembers.Member. Must be of type float.
    
    Returns:
    
    float[]
  - getJavaArrayByte
```
public byte[] getJavaArrayByte(int index,
                               StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get member data of type byte as a 1D array.
    
    Overrides:
    
    getJavaArrayByte in class ArrayStructure
    
    Parameters:
    
    index - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - get data from this StructureMembers.Member. Must be of type byte.
    
    Returns:
    
    byte[]
  - getJavaArrayShort
```
public short[] getJavaArrayShort(int index,
                                 StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get member data of type short as a 1D array.
    
    Overrides:
    
    getJavaArrayShort in class ArrayStructure
    
    Parameters:
    
    index - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - get data from this StructureMembers.Member. Must be of type float.
    
    Returns:
    
    short[]
  - getJavaArrayInt
```
public int[] getJavaArrayInt(int index,
                             StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get member data of type int as a 1D array.
    
    Overrides:
    
    getJavaArrayInt in class ArrayStructure
    
    Parameters:
    
    index - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - get data from this StructureMembers.Member. Must be of type int.
    
    Returns:
    
    int[]
  - getJavaArrayLong
```
public long[] getJavaArrayLong(int index,
                               StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get member data of type long as a 1D array.
    
    Overrides:
    
    getJavaArrayLong in class ArrayStructure
    
    Parameters:
    
    index - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - get data from this StructureMembers.Member. Must be of type long.
    
    Returns:
    
    long[]
  - getJavaArrayChar
```
public char[] getJavaArrayChar(int index,
                               StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get member data of type char as a 1D array.
    
    Overrides:
    
    getJavaArrayChar in class ArrayStructure
    
    Parameters:
    
    index - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - get data from this StructureMembers.Member. Must be of type char.
    
    Returns:
    
    char[]
  - getJavaArrayString
```
public java.lang.String[] getJavaArrayString(int index,
                                             StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get member data of type String as a 1D array.
    
    Overrides:
    
    getJavaArrayString in class ArrayStructure
    
    Parameters:
    
    index - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - get data from this StructureMembers.Member. Must be of type String.
    
    Returns:
    
    String[]
  - getJavaArrayOpaque
```
public java.nio.ByteBuffer[] getJavaArrayOpaque(int index,
                                                StructureMembers.Member m)
```
  - getScalarStructure
```
public StructureData getScalarStructure(int index,
                                        StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get member data of type Structure.
    
    Overrides:
    
    getScalarStructure in class ArrayStructure
    
    Parameters:
    
    index - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - get data from this StructureMembers.Member. Must be of type Structure.
    
    Returns:
    
    scalar StructureData
  - getArrayStructure
```
public ArrayStructure getArrayStructure(int index,
                                        StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get member data of type array of Structure.
    
    Overrides:
    
    getArrayStructure in class ArrayStructure
    
    Parameters:
    
    index - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - get data from this StructureMembers.Member. Must be of type Structure.
    
    Returns:
    
    nested ArrayStructure.
  - 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
  - makeStructureData
```
protected StructureData makeStructureData(ArrayStructure as,
                                          int index)
```
    Specified by:
    
    makeStructureData in class ArrayStructure
  - memberArray
```
protected Array memberArray(int recno,
                            int memberindex)
```
  - memberIndex
```
protected static int memberIndex(StructureMembers.Member m)
```
  - getAtomicArray
```
protected CDMArrayAtomic getAtomicArray(int index,
                                        StructureMembers.Member m)
```

Class CDMArrayStructure

Nested Class Summary

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

Field Summary

Fields inherited from class ucar.ma2.ArrayStructure

Fields inherited from class ucar.ma2.Array

Method Summary

Methods inherited from class ucar.ma2.ArrayStructure

Methods inherited from class ucar.ma2.Array

Methods inherited from class java.lang.Object

Field Detail

root

dsp

template

bytesize

basetype

primitivetype

d4data

dimsize

nmembers

instances

Method Detail

getDSP

getRoot

getTemplate

getByteSize

getBaseType

getPrimitiveType

getSize

toString

computeTotalSize

getStructureData

getArray

getScalarDouble

getScalarFloat

getScalarByte

getScalarShort

getScalarInt

getScalarLong

getScalarChar

getScalarString

getJavaArrayDouble

getJavaArrayFloat

getJavaArrayByte

getJavaArrayShort

getJavaArrayInt

getJavaArrayLong

getJavaArrayChar

getJavaArrayString

getJavaArrayOpaque

getScalarStructure

getArrayStructure

getArraySequence

copy

makeStructureData

memberArray

memberIndex

getAtomicArray