Package ucar.ma2

Class StructureDataComposite

java.lang.Object

ucar.ma2.StructureData

ucar.ma2.StructureDataComposite

public class StructureDataComposite
extends StructureData

A composite of other StructureData. If multiple members of same name exist, the first one added is used TODO make Immutable

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,StructureData>	proxy

Fields inherited from class ucar.ma2.StructureData

EMPTY, members

Constructor Summary

Constructors

Constructor	Description
StructureDataComposite()	Deprecated. use StructureDataComposite.make(StructureData...

Method Summary

Modifier and Type	Method	Description
void	add(int pos, StructureData sdata)	Deprecated. use StructureDataComposite.make(StructureData...
void	add(StructureData sdata)	Deprecated. use StructureDataComposite.make(StructureData...
double	convertScalarDouble(StructureMembers.Member m)	Get scalar value as a double, with conversion as needed.
float	convertScalarFloat(StructureMembers.Member m)	Get scalar value as a float, with conversion as needed.
int	convertScalarInt(StructureMembers.Member m)	Get scalar value as a int, with conversion as needed.
long	convertScalarLong(StructureMembers.Member m)	Get scalar value as a int, with conversion as needed.
static StructureDataComposite	create(Iterable<StructureData> sdatas)
Array	getArray(StructureMembers.Member m)	Get member data array of any type as an Array.
ArraySequence	getArraySequence(StructureMembers.Member m)	Get ArraySequence for a member of type Sequence.
ArrayStructure	getArrayStructure(StructureMembers.Member m)	Get ArrayStructure for a member of type Structure.
byte[]	getJavaArrayByte(StructureMembers.Member m)	Get java byte array for a member of type byte.
char[]	getJavaArrayChar(StructureMembers.Member m)	Get java char array for a member of type char.
double[]	getJavaArrayDouble(StructureMembers.Member m)	Get java double array for a member of type double.
float[]	getJavaArrayFloat(StructureMembers.Member m)	Get java float array for a member of type float.
int[]	getJavaArrayInt(StructureMembers.Member m)	Get java int array for a member of type int.
long[]	getJavaArrayLong(StructureMembers.Member m)	Get java long array for a member of type long.
short[]	getJavaArrayShort(StructureMembers.Member m)	Get java short array for a member of type short.
String[]	getJavaArrayString(StructureMembers.Member m)	Get java array of Strings for a member of type char or String.
byte	getScalarByte(StructureMembers.Member m)	Get member data of type byte.
char	getScalarChar(StructureMembers.Member m)	Get member data of type char.
double	getScalarDouble(StructureMembers.Member m)	Get member data of type double.
float	getScalarFloat(StructureMembers.Member m)	Get member data of type float.
int	getScalarInt(StructureMembers.Member m)	Get member data of type int.
long	getScalarLong(StructureMembers.Member m)	Get member data of type long.
Object	getScalarObject(StructureMembers.Member m)	Get member data array of any type as an Object, eg, Float, Double, String etc.
short	getScalarShort(StructureMembers.Member m)	Get member data of type short.
String	getScalarString(StructureMembers.Member m)	Get String value, from rank 0 String or rank 1 char member array.
StructureData	getScalarStructure(StructureMembers.Member m)	Get member data of type Structure.

Methods inherited from class ucar.ma2.StructureData

convertScalarDouble, convertScalarFloat, convertScalarInt, convertScalarLong, findMember, getArray, getArraySequence, getArrayStructure, getJavaArrayByte, getJavaArrayChar, getJavaArrayDouble, getJavaArrayFloat, getJavaArrayInt, getJavaArrayLong, getJavaArrayShort, getJavaArrayString, getMembers, getName, getScalarByte, getScalarChar, getScalarDouble, getScalarFloat, getScalarInt, getScalarLong, getScalarObject, getScalarShort, getScalarString, getScalarStructure, getStructureMembers, showInternal, showInternalMembers, toString

Methods inherited from class java.lang.Object

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

Field Detail

proxy

protected Map<String,StructureData> proxy

Constructor Detail

StructureDataComposite

@Deprecated
public StructureDataComposite()

Deprecated.

use StructureDataComposite.make(StructureData... sdatas)

Method Detail

create

public static StructureDataComposite create(Iterable<StructureData> sdatas)

add

@Deprecated
public void add(StructureData sdata)

Deprecated.

use StructureDataComposite.make(StructureData... sdatas)

add

@Deprecated
public void add(int pos,
                StructureData sdata)

Deprecated.

use StructureDataComposite.make(StructureData... sdatas)

getArray

public Array getArray(StructureMembers.Member m)

Description copied from class: StructureData

Get member data array of any type as an Array.

Specified by:

getArray in class StructureData

Parameters:

m - get data from this StructureMembers.Member.

Returns:

Array values.

convertScalarFloat

public float convertScalarFloat(StructureMembers.Member m)

Description copied from class: StructureData

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

Specified by:

convertScalarFloat in class StructureData

Parameters:

m - member Variable.

Returns:

scalar value as a float

convertScalarDouble

public double convertScalarDouble(StructureMembers.Member m)

Description copied from class: StructureData

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

Specified by:

convertScalarDouble in class StructureData

Parameters:

m - member Variable.

Returns:

scalar value as a double

convertScalarInt

public int convertScalarInt(StructureMembers.Member m)

Description copied from class: StructureData

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

Specified by:

convertScalarInt in class StructureData

Parameters:

m - member Variable.

Returns:

scalar value as a int

convertScalarLong

public long convertScalarLong(StructureMembers.Member m)

Description copied from class: StructureData

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

Specified by:

convertScalarLong in class StructureData

Parameters:

m - member Variable.

Returns:

scalar value as a int

getScalarDouble

public double getScalarDouble(StructureMembers.Member m)

Description copied from class: StructureData

Get member data of type double.

Specified by:

getScalarDouble in class StructureData

Parameters:

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

Returns:

scalar double value

getJavaArrayDouble

public double[] getJavaArrayDouble(StructureMembers.Member m)

Description copied from class: StructureData

Get java double array for a member of type double.

Specified by:

getJavaArrayDouble in class StructureData

Parameters:

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

Returns:

1D java array of doubles

getScalarFloat

public float getScalarFloat(StructureMembers.Member m)

Description copied from class: StructureData

Get member data of type float.

Specified by:

getScalarFloat in class StructureData

Parameters:

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

Returns:

scalar double value

getJavaArrayFloat

public float[] getJavaArrayFloat(StructureMembers.Member m)

Description copied from class: StructureData

Get java float array for a member of type float.

Specified by:

getJavaArrayFloat in class StructureData

Parameters:

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

Returns:

1D java array of floats

getScalarByte

public byte getScalarByte(StructureMembers.Member m)

Description copied from class: StructureData

Get member data of type byte.

Specified by:

getScalarByte in class StructureData

Parameters:

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

Returns:

scalar byte value

getJavaArrayByte

public byte[] getJavaArrayByte(StructureMembers.Member m)

Description copied from class: StructureData

Get java byte array for a member of type byte.

Specified by:

getJavaArrayByte in class StructureData

Parameters:

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

Returns:

1D java array of bytes

getScalarInt

public int getScalarInt(StructureMembers.Member m)

Description copied from class: StructureData

Get member data of type int.

Specified by:

getScalarInt in class StructureData

Parameters:

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

Returns:

scalar int value

getJavaArrayInt

public int[] getJavaArrayInt(StructureMembers.Member m)

Description copied from class: StructureData

Get java int array for a member of type int.

Specified by:

getJavaArrayInt in class StructureData

Parameters:

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

Returns:

1D java array of ints

getScalarShort

public short getScalarShort(StructureMembers.Member m)

Description copied from class: StructureData

Get member data of type short.

Specified by:

getScalarShort in class StructureData

Parameters:

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

Returns:

scalar short value

getJavaArrayShort

public short[] getJavaArrayShort(StructureMembers.Member m)

Description copied from class: StructureData

Get java short array for a member of type short.

Specified by:

getJavaArrayShort in class StructureData

Parameters:

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

Returns:

1D java array of shorts

getScalarLong

public long getScalarLong(StructureMembers.Member m)

Description copied from class: StructureData

Get member data of type long.

Specified by:

getScalarLong in class StructureData

Parameters:

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

Returns:

scalar long value

getJavaArrayLong

public long[] getJavaArrayLong(StructureMembers.Member m)

Description copied from class: StructureData

Get java long array for a member of type long.

Specified by:

getJavaArrayLong in class StructureData

Parameters:

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

Returns:

1D java array of longs

getScalarChar

public char getScalarChar(StructureMembers.Member m)

Description copied from class: StructureData

Get member data of type char.

Specified by:

getScalarChar in class StructureData

Parameters:

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

Returns:

scalar char value

getJavaArrayChar

public char[] getJavaArrayChar(StructureMembers.Member m)

Description copied from class: StructureData

Get java char array for a member of type char.

Specified by:

getJavaArrayChar in class StructureData

Parameters:

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

Returns:

1D java array of chars

getScalarString

public String getScalarString(StructureMembers.Member m)

Description copied from class: StructureData

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

Specified by:

getScalarString in class StructureData

Parameters:

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

Returns:

scalar String value

getJavaArrayString

public String[] getJavaArrayString(StructureMembers.Member m)

Description copied from class: StructureData

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

Specified by:

getJavaArrayString in class StructureData

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(StructureMembers.Member m)

Description copied from class: StructureData

Get member data of type Structure.

Specified by:

getScalarStructure in class StructureData

Parameters:

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

Returns:

StructureData

getArrayStructure

public ArrayStructure getArrayStructure(StructureMembers.Member m)

Description copied from class: StructureData

Get ArrayStructure for a member of type Structure.

Specified by:

getArrayStructure in class StructureData

Parameters:

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

Returns:

ArrayStructure

getArraySequence

public ArraySequence getArraySequence(StructureMembers.Member m)

Description copied from class: StructureData

Get ArraySequence for a member of type Sequence.

Specified by:

getArraySequence in class StructureData

Parameters:

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

Returns:

ArrayStructure

getScalarObject

public Object getScalarObject(StructureMembers.Member m)

Description copied from class: StructureData

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

Overrides:

getScalarObject in class StructureData

Parameters:

m - get data from this StructureMembers.Member.

Returns:

value as Float, Double, etc..