ucar.ma2
Class ArraySequence

java.lang.Object
  ucar.ma2.Array
      ucar.ma2.ArrayStructure
          ucar.ma2.ArraySequence

public class ArraySequence
extends ArrayStructure

Handles nested sequences: a 1D array of variable length 1D arrays of StructureData. Uses same technique as ArrayStructureMA for the inner fields; data storage is in member arrays. Example use:

    ArraySequence aseq = new ArraySequence( members, outerLength);
    for (int seq=0; seq < outerLength; seq++) {
      aseq.setSequenceLength(seq, seqLength);
    }
    aseq.finish();
 

Version:

$Revision:51 $ $Date:2006-07-12 17:13:13Z $

Author:

caron

Field Summary

Fields inherited from class ucar.ma2.ArrayStructure

members, nelems, sdata

Fields inherited from class ucar.ma2.Array

indexCalc, rank, scalarIndex

Constructor Summary

ArraySequence(StructureMembers members, int nseq)
This is used for inner sequences, ie variable length structures nested inside of another structure.

Method Summary

void	finish() Call this when you have set all the sequence lengths.
ArrayStructure	flatten() Flatten the Structures into a 1D array of Structures of length getTotalNumberOfStructures().
ArrayStructure	getArrayStructure(int recnum, StructureMembers.Member m) Get member data of type array of Structure.
byte[]	getJavaArrayByte(int recnum, StructureMembers.Member m) Get member data of type byte as a 1D array.
char[]	getJavaArrayChar(int recnum, 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 recnum, StructureMembers.Member m) Get member data of type float as a 1D array.
int[]	getJavaArrayInt(int recnum, StructureMembers.Member m) Get member data of type int as a 1D array.
long[]	getJavaArrayLong(int recnum, StructureMembers.Member m) Get member data of type long as a 1D array.
short[]	getJavaArrayShort(int recnum, StructureMembers.Member m) Get member data of type short as a 1D array.
java.lang.String[]	getJavaArrayString(int recnum, StructureMembers.Member m) Get member data of type String as a 1D array.
byte	getScalarByte(int recnum, StructureMembers.Member m) Get scalar member data of type byte.
char	getScalarChar(int recnum, StructureMembers.Member m) Get scalar member data of type char.
double	getScalarDouble(int recnum, StructureMembers.Member m) Get scalar member data of type double.
float	getScalarFloat(int recnum, StructureMembers.Member m) Get scalar member data of type float.
int	getScalarInt(int recnum, StructureMembers.Member m) Get scalar member data of type int.
long	getScalarLong(int recnum, StructureMembers.Member m) Get scalar member data of type long.
short	getScalarShort(int recnum, StructureMembers.Member m) Get scalar member data of type short.
java.lang.String	getScalarString(int recnum, StructureMembers.Member m) Get member data of type String or char.
StructureData	getScalarStructure(int recnum, StructureMembers.Member m) Get member data of type Structure.
int	getSequenceLength(int outerIndex) Get the length of the ith sequence.
int	getSequenceOffset(int outerIndex) Get the the starting index of the ith sequence.
java.lang.Object	getStorage() Return backing storage in the StructureMembers
StructureData	getStructureData(int index) Get the index-th StructureData of this ArrayStructure.
int	getTotalNumberOfStructures() Get the total number of Structures over all the nested sequences.
protected StructureData	makeStructureData(ArrayStructure as, int index)
void	setSequenceLength(int outerIndex, int len) Set the length of one of the sequences.

Methods inherited from class ucar.ma2.ArrayStructure

convertScalarDouble, copy, createView, getArray, getArrayByte, getArrayChar, getArrayDouble, getArrayFloat, getArrayInt, getArrayLong, getArrayShort, getArrayString, getBoolean, getByte, getChar, getDouble, getElementType, getFloat, getInt, getLong, getObject, getObject, getObject, getScalarObject, getShort, getStructureData, getStructureMembers, getStructureSize, setBoolean, setByte, setChar, setDouble, setFloat, setInt, setLong, setObject, setShort

Methods inherited from class ucar.ma2.Array

arraycopy, copyTo1DJavaArray, copyToNDJavaArray, factory, factory, factory, factory, factoryConstant, flip, get1DJavaArray, getIndex, getIndexIterator, getIndexIteratorFast, getIndexName, getRangeIterator, getRank, getShape, getSize, permute, reduce, reduce, reshape, section, section, section, sectionNoReduce, sectionNoReduce, setIndexName, shapeToString, slice, toString, transpose

Methods inherited from class java.lang.Object

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

Constructor Detail

ArraySequence

public ArraySequence(StructureMembers members,
                     int nseq)

This is used for inner sequences, ie variable length structures nested inside of another structure.

Parameters:

members - the members of the STructure

nseq - the number of sequences, ie the length of the outer structure.

Method Detail

makeStructureData

protected StructureData makeStructureData(ArrayStructure as,
                                          int index)

Specified by:

makeStructureData in class ArrayStructure

getStructureData

public StructureData getStructureData(int index)

Description copied from class: ArrayStructure

Get the index-th StructureData of this ArrayStructure.

Overrides:

getStructureData in class ArrayStructure

Parameters:

index - which one to get, specified by an integer.

Returns:

object of type StructureData.

setSequenceLength

public void setSequenceLength(int outerIndex,
                              int len)

Set the length of one of the sequences.

Parameters:

outerIndex - which sequence?

len - what is its length?

getSequenceLength

public int getSequenceLength(int outerIndex)

Get the length of the ith sequence.

Parameters:

outerIndex - which sequence?

Returns:

its length

getSequenceOffset

public int getSequenceOffset(int outerIndex)

Get the the starting index of the ith sequence.

Parameters:

outerIndex - which sequence?

Returns:

its starting index

finish

public void finish()

Call this when you have set all the sequence lengths.

getTotalNumberOfStructures

public int getTotalNumberOfStructures()

Get the total number of Structures over all the nested sequences.

getStorage

public java.lang.Object getStorage()

Return backing storage in the StructureMembers

Specified by:

getStorage in class Array

flatten

public ArrayStructure flatten()

Flatten the Structures into a 1D array of Structures of length getTotalNumberOfStructures().

Returns:

Array of Structures

getScalarDouble

public double getScalarDouble(int recnum,
                              StructureMembers.Member m)

Description copied from class: ArrayStructure

Get scalar member data of type double.

Specified by:

getScalarDouble 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:

scalar double 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.

Specified by:

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[]

getScalarFloat

public float getScalarFloat(int recnum,
                            StructureMembers.Member m)

Description copied from class: ArrayStructure

Get scalar member data of type float.

Specified by:

getScalarFloat 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 float.

Returns:

scalar double value

getJavaArrayFloat

public float[] getJavaArrayFloat(int recnum,
                                 StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data of type float as a 1D array.

Specified by:

getJavaArrayFloat 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 float.

Returns:

float[]

getScalarByte

public byte getScalarByte(int recnum,
                          StructureMembers.Member m)

Description copied from class: ArrayStructure

Get scalar member data of type byte.

Specified by:

getScalarByte 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 byte.

Returns:

scalar double value

getJavaArrayByte

public byte[] getJavaArrayByte(int recnum,
                               StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data of type byte as a 1D array.

Specified by:

getJavaArrayByte 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 byte.

Returns:

byte[]

getScalarShort

public short getScalarShort(int recnum,
                            StructureMembers.Member m)

Description copied from class: ArrayStructure

Get scalar member data of type short.

Specified by:

getScalarShort 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 short.

Returns:

scalar double value

getJavaArrayShort

public short[] getJavaArrayShort(int recnum,
                                 StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data of type short as a 1D array.

Specified by:

getJavaArrayShort 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 float.

Returns:

short[]

getScalarInt

public int getScalarInt(int recnum,
                        StructureMembers.Member m)

Description copied from class: ArrayStructure

Get scalar member data of type int.

Specified by:

getScalarInt 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 int.

Returns:

scalar double value

getJavaArrayInt

public int[] getJavaArrayInt(int recnum,
                             StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data of type int as a 1D array.

Specified by:

getJavaArrayInt 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 int.

Returns:

int[]

getScalarLong

public long getScalarLong(int recnum,
                          StructureMembers.Member m)

Description copied from class: ArrayStructure

Get scalar member data of type long.

Specified by:

getScalarLong 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 long.

Returns:

scalar double value

getJavaArrayLong

public long[] getJavaArrayLong(int recnum,
                               StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data of type long as a 1D array.

Specified by:

getJavaArrayLong 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 long.

Returns:

long[]

getScalarChar

public char getScalarChar(int recnum,
                          StructureMembers.Member m)

Description copied from class: ArrayStructure

Get scalar member data of type char.

Specified by:

getScalarChar 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 char.

Returns:

scalar double value

getJavaArrayChar

public char[] getJavaArrayChar(int recnum,
                               StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data of type char as a 1D array.

Specified by:

getJavaArrayChar 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 char.

Returns:

char[]

getScalarString

public java.lang.String getScalarString(int recnum,
                                        StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data of type String or char.

Specified by:

getScalarString 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 String or char.

Returns:

scalar String value

getJavaArrayString

public java.lang.String[] getJavaArrayString(int recnum,
                                             StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data of type String as a 1D array.

Specified by:

getJavaArrayString 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 String.

Returns:

String[]

getScalarStructure

public StructureData getScalarStructure(int recnum,
                                        StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data of type Structure.

Specified by:

getScalarStructure 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 Structure.

Returns:

scalar StructureData

getArrayStructure

public ArrayStructure getArrayStructure(int recnum,
                                        StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data of type array of Structure.

Specified by:

getArrayStructure 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 Structure.

Returns:

nested ArrayStructure.