ucar.ma2
Class StructureData

java.lang.Object
  ucar.ma2.StructureData

Direct Known Subclasses:

StructureDataA, StructureDataW

public abstract class StructureData
extends java.lang.Object

A container for a Structure's data. Is normally contained within an ArrayStructure, which is an Array of StructureData. This is the abstract supertype for all implementations.

Constructor Summary

StructureData(StructureMembers members)
Constructor.

Method Summary

abstract double	convertScalarDouble(StructureMembers.Member m) Get scalar value as a double, with conversion as needed.
abstract float	convertScalarFloat(StructureMembers.Member m) Get scalar value as a float, with conversion as needed.
static StructureData	copy(StructureData from) Copy all the data out of 'from' and into a new StructureData.
StructureMembers.Member	findMember(java.lang.String memberName) Find a member by its name.
Array	findMemberArray(java.lang.String memberName) Deprecated. use getArray(String memberName), or getArray(StructureMembers.Member m)
Array	getArray(java.lang.String memberName) Get member data array of any type as an Array.
abstract Array	getArray(StructureMembers.Member m) Get member data array of any type as an Array.
byte[]	getArrayByte(StructureMembers.Member m) Deprecated. use getJavaArrayByte(m)
char[]	getArrayChar(StructureMembers.Member m) Deprecated. use getJavaArrayChar(m)
double[]	getArrayDouble(StructureMembers.Member m) Deprecated. use getJavaArrayDouble(m)
float[]	getArrayFloat(StructureMembers.Member m) Deprecated. use getJavaArrayFloat(m)
int[]	getArrayInt(StructureMembers.Member m) Deprecated. use getJavaArrayInt(m)
long[]	getArrayLong(StructureMembers.Member m) Deprecated. use getJavaArrayLong(m)
short[]	getArrayShort(StructureMembers.Member m) Deprecated. use getJavaArrayShort(m)
abstract ArrayStructure	getArrayStructure(StructureMembers.Member m) Get ArrayStructure for a member of type Structure.
abstract byte[]	getJavaArrayByte(StructureMembers.Member m) Get java byte array for a member of type byte.
abstract char[]	getJavaArrayChar(StructureMembers.Member m) Get java char array for a member of type char.
abstract double[]	getJavaArrayDouble(StructureMembers.Member m) Get java double array for a member of type double.
abstract float[]	getJavaArrayFloat(StructureMembers.Member m) Get java float array for a member of type float.
abstract int[]	getJavaArrayInt(StructureMembers.Member m) Get java int array for a member of type int.
abstract long[]	getJavaArrayLong(StructureMembers.Member m) Get java long array for a member of type long.
abstract short[]	getJavaArrayShort(StructureMembers.Member m) Get java short array for a member of type short.
abstract java.lang.String[]	getJavaArrayString(StructureMembers.Member m) Get java array of Strings for a member of type char or String.
StructureMembers.Member	getMember(int index) Get StructureMembers.Member by index
java.util.List	getMembers() Get List of StructureMembers.Member
java.lang.String	getName() Get name of Structure
java.lang.Object	getObject(StructureMembers.Member m) Deprecated. use getScalarObject(m)
byte	getScalarByte(java.lang.String memberName) Get byte value.
abstract byte	getScalarByte(StructureMembers.Member m) Get member data of type byte.
char	getScalarChar(java.lang.String memberName) Get char value.
abstract char	getScalarChar(StructureMembers.Member m) Get member data of type char.
double	getScalarDouble(java.lang.String memberName) Get double value.
abstract double	getScalarDouble(StructureMembers.Member m) Get member data of type double.
float	getScalarFloat(java.lang.String memberName) Get float value.
abstract float	getScalarFloat(StructureMembers.Member m) Get member data of type float.
int	getScalarInt(java.lang.String memberName) Get int value.
abstract int	getScalarInt(StructureMembers.Member m) Get member data of type int.
long	getScalarLong(java.lang.String memberName) Get long value.
abstract long	getScalarLong(StructureMembers.Member m) Get member data of type long.
java.lang.Object	getScalarObject(StructureMembers.Member m) Get member data array of any type as an Object, eg, Float, Double, String etc.
short	getScalarShort(java.lang.String memberName) Get short value.
abstract short	getScalarShort(StructureMembers.Member m) Get member data of type short.
java.lang.String	getScalarString(java.lang.String memberName) Get String value, from rank 0 String or rank 1 char member array.
abstract java.lang.String	getScalarString(StructureMembers.Member m) Get String value, from rank 0 String or rank 1 char member array.
StructureData	getScalarStructure(java.lang.String memberName) Get member data of type Structure.
abstract StructureData	getScalarStructure(StructureMembers.Member m) Get member data of type Structure.
StructureMembers	getStructureMembers() Get StructureMembers object

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StructureData

public StructureData(StructureMembers members)

Constructor.

Parameters:

members - StructureData is always contained in a StructureArray.

Method Detail

copy

public static StructureData copy(StructureData from)

Copy all the data out of 'from' and into a new StructureData.

Parameters:

from - copy from here

Returns:

a new StructureData object.

getName

public java.lang.String getName()

Get name of Structure

getStructureMembers

public StructureMembers getStructureMembers()

Get StructureMembers object

getMembers

public java.util.List getMembers()

Get List of StructureMembers.Member

getMember

public StructureMembers.Member getMember(int index)

Get StructureMembers.Member by index

findMember

public StructureMembers.Member findMember(java.lang.String memberName)

Find a member by its name.

Returns:

StructureMembers.Member matching the name, or null if not found

findMemberArray

public Array findMemberArray(java.lang.String memberName)

Deprecated. use getArray(String memberName), or getArray(StructureMembers.Member m)

getArray

public abstract Array getArray(StructureMembers.Member m)

Get member data array of any type as an Array.

Parameters:

m - get data from this StructureMembers.Member.

Returns:

Array values.

getArray

public Array getArray(java.lang.String memberName)

Get member data array of any type as an Array. For more efficiency, use getArray(StructureMembers.Member m).

Parameters:

memberName - name of member Variable.

Throws:

java.lang.IllegalArgumentException - if name is not legal member name.

getScalarObject

public java.lang.Object getScalarObject(StructureMembers.Member m)

Get member data array of any type as an Object, eg, Float, Double, String etc.

Parameters:

m - get data from this StructureMembers.Member.

Returns:

value as Float, Double, etc..

getObject

public java.lang.Object getObject(StructureMembers.Member m)

Deprecated. use getScalarObject(m)

convertScalarFloat

public abstract float convertScalarFloat(StructureMembers.Member m)

Get scalar value as a float, with conversion as needed. Underlying type must be convertible to float.

Parameters:

m - member Variable.

Throws:

ForbiddenConversionException - if not convertible to float.

convertScalarDouble

public abstract double convertScalarDouble(StructureMembers.Member m)

Get scalar value as a double, with conversion as needed. Underlying type must be convertible to double.

Parameters:

m - member Variable.

Throws:

ForbiddenConversionException - if not convertible to double.

getScalarDouble

public double getScalarDouble(java.lang.String memberName)

Get double value. Underlying type must be convertible to double. For more efficiency, use getScalarDouble(StructureMembers.Member m) if possible.

Parameters:

memberName - name of member Variable.

Throws:

java.lang.IllegalArgumentException - if name is not legal member name.

getScalarDouble

public abstract double getScalarDouble(StructureMembers.Member m)

Get member data of type double.

Parameters:

m - get data from this StructureMembers.Member. Must be of type double.

Returns:

scalar double value

getArrayDouble

public double[] getArrayDouble(StructureMembers.Member m)

Deprecated. use getJavaArrayDouble(m)

getJavaArrayDouble

public abstract double[] getJavaArrayDouble(StructureMembers.Member m)

Get java double array for a member of type double.

Parameters:

m - get data from this StructureMembers.Member. Must be of type double.

Returns:

1D java array of doubles

getScalarFloat

public float getScalarFloat(java.lang.String memberName)

Get float value. Underlying type must be convertible to float. For more efficiency, use getScalarFloat(StructureMembers.Member m) if possible.

Parameters:

memberName - name of member Variable.

Throws:

java.lang.IllegalArgumentException - if name is not legal member name.

getScalarFloat

public abstract float getScalarFloat(StructureMembers.Member m)

Get member data of type float.

Parameters:

m - get data from this StructureMembers.Member. Must be of type float.

Returns:

scalar double value

getJavaArrayFloat

public abstract float[] getJavaArrayFloat(StructureMembers.Member m)

Get java float array for a member of type float.

Parameters:

m - get data from this StructureMembers.Member. Must be of type float.

Returns:

1D java array of floats

getArrayFloat

public float[] getArrayFloat(StructureMembers.Member m)

Deprecated. use getJavaArrayFloat(m)

getScalarByte

public byte getScalarByte(java.lang.String memberName)

Get byte value. Underlying type must be convertible to byte. For more efficiency, use getScalarByte(StructureMembers.Member m) if possible.

Parameters:

memberName - name of member Variable.

Throws:

java.lang.IllegalArgumentException - if name is not legal member name.

getScalarByte

public abstract byte getScalarByte(StructureMembers.Member m)

Get member data of type byte.

Parameters:

m - get data from this StructureMembers.Member. Must be of type byte.

Returns:

scalar byte value

getJavaArrayByte

public abstract byte[] getJavaArrayByte(StructureMembers.Member m)

Get java byte array for a member of type byte.

Parameters:

m - get data from this StructureMembers.Member. Must be of type byte.

Returns:

1D java array of bytes

getArrayByte

public byte[] getArrayByte(StructureMembers.Member m)

Deprecated. use getJavaArrayByte(m)

getScalarInt

public int getScalarInt(java.lang.String memberName)

Get int value. Underlying type must be convertible to int. For more efficiency, use getScalarDouble(StructureMembers.Member m) if possible.

Parameters:

memberName - name of member Variable.

Throws:

java.lang.IllegalArgumentException - if name is not legal member name.

getScalarInt

public abstract int getScalarInt(StructureMembers.Member m)

Get member data of type int.

Parameters:

m - get data from this StructureMembers.Member. Must be of type int.

Returns:

scalar int value

getJavaArrayInt

public abstract int[] getJavaArrayInt(StructureMembers.Member m)

Get java int array for a member of type int.

Parameters:

m - get data from this StructureMembers.Member. Must be of type int.

Returns:

1D java array of ints

getArrayInt

public int[] getArrayInt(StructureMembers.Member m)

Deprecated. use getJavaArrayInt(m)

getScalarShort

public short getScalarShort(java.lang.String memberName)

Get short value. Underlying type must be convertible to short. For more efficiency, use getScalarDouble(StructureMembers.Member m) if possible.

Parameters:

memberName - name of member Variable.

Throws:

java.lang.IllegalArgumentException - if name is not legal member name.

getScalarShort

public abstract short getScalarShort(StructureMembers.Member m)

Get member data of type short.

Parameters:

m - get data from this StructureMembers.Member. Must be of type short.

Returns:

scalar short value

getJavaArrayShort

public abstract short[] getJavaArrayShort(StructureMembers.Member m)

Get java short array for a member of type short.

Parameters:

m - get data from this StructureMembers.Member. Must be of type short.

Returns:

1D java array of shorts

getArrayShort

public short[] getArrayShort(StructureMembers.Member m)

Deprecated. use getJavaArrayShort(m)

getScalarLong

public long getScalarLong(java.lang.String memberName)

Get long value. Underlying type must be convertible to long. For more efficiency, use getScalarDouble(StructureMembers.Member m) if possible.

Parameters:

memberName - name of member Variable.

Throws:

java.lang.IllegalArgumentException - if name is not legal member name.

getScalarLong

public abstract long getScalarLong(StructureMembers.Member m)

Get member data of type long.

Parameters:

m - get data from this StructureMembers.Member. Must be of type long.

Returns:

scalar long value

getJavaArrayLong

public abstract long[] getJavaArrayLong(StructureMembers.Member m)

Get java long array for a member of type long.

Parameters:

m - get data from this StructureMembers.Member. Must be of type long.

Returns:

1D java array of longs

getArrayLong

public long[] getArrayLong(StructureMembers.Member m)

Deprecated. use getJavaArrayLong(m)

getScalarChar

public char getScalarChar(java.lang.String memberName)

Get char value. Underlying type must be convertible to char. For more efficiency, use getScalarDouble(StructureMembers.Member m) if possible.

Parameters:

memberName - name of member Variable.

Throws:

java.lang.IllegalArgumentException - if name is not legal member name.

getScalarChar

public abstract char getScalarChar(StructureMembers.Member m)

Get member data of type char.

Parameters:

m - get data from this StructureMembers.Member. Must be of type char.

Returns:

scalar char value

getJavaArrayChar

public abstract char[] getJavaArrayChar(StructureMembers.Member m)

Get java char array for a member of type char.

Parameters:

m - get data from this StructureMembers.Member. Must be of type char.

Returns:

1D java array of chars

getArrayChar

public char[] getArrayChar(StructureMembers.Member m)

Deprecated. use getJavaArrayChar(m)

getScalarString

public java.lang.String getScalarString(java.lang.String memberName)

Get String value, from rank 0 String or rank 1 char member array. For more efficiency, use getScalarString(StructureMembers.Member m) if possible.

Parameters:

memberName - name of member Variable.

Throws:

java.lang.IllegalArgumentException - if name is not legal member name.

getScalarString

public abstract java.lang.String getScalarString(StructureMembers.Member m)

Get String value, from rank 0 String or rank 1 char member array.

Parameters:

m - get data from this StructureMembers.Member. Must be of type char or String.

getJavaArrayString

public abstract java.lang.String[] getJavaArrayString(StructureMembers.Member m)

Get java array of Strings for a member of type char or String.

Parameters:

m - get data from this StructureMembers.Member. Must be of type char or String.

Returns:

1D java array of String

getScalarStructure

public StructureData getScalarStructure(java.lang.String memberName)

Get member data of type Structure. For more efficiency, use getScalarStructure(StructureMembers.Member m) if possible.

Parameters:

memberName - name of member Variable.

Throws:

java.lang.IllegalArgumentException - if name is not legal member name.

getScalarStructure

public abstract StructureData getScalarStructure(StructureMembers.Member m)

Get member data of type Structure.

Parameters:

m - get data from this StructureMembers.Member. Must be of type Structure.

Returns:

StructureData

getArrayStructure

public abstract ArrayStructure getArrayStructure(StructureMembers.Member m)

Get ArrayStructure for a member of type Structure.

Parameters:

m - get data from this StructureMembers.Member. Must be of type Structure.

Returns:

ArrayStructure