ucar.unidata.metdata

Class Ensemble

java.lang.Object

ucar.unidata.metdata.Ensemble

All Implemented Interfaces:

java.io.Serializable

public class Ensemble
extends java.lang.Object
implements java.io.Serializable

A class for holding an ensemble of Quantitys and Values. Each Quantity can have only one associated Value.

Version:

$Revision: 1.7 $

Author:

Glenn Davis

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Ensemble() Create a new Ensemble

Method Summary

Modifier and Type	Method and Description
java.util.Set	entrySet() Get the set of Values in the Ensemble.
boolean	equals(java.lang.Object oo) See if the Object in question is equal to this Ensemble.
java.lang.StringBuffer	format(java.lang.StringBuffer buf) Format the entire Ensemble.
protected java.lang.StringBuffer	formatEntry(java.lang.StringBuffer buf, java.util.Map.Entry entry) Format the Entry.
Value	get(Quantity qq) Get the Value of a Quantity from the Ensemble
Value	get(java.lang.String qstr) Get the Value from the Ensemble by Quantity name
int	hashCode() Return the hash code for this object.
boolean	isEmpty() See if this ensemble is empty
java.util.Set	keySet() Get the set of Quantitys in the Ensemble.
Value	put(Quantity qq, Value vv) Put a Quantity in the Ensemble
Value	put(java.lang.String qstr, int vv, java.lang.String uStr) Pust a Quantity into the Ensemble.
int	size() Get the size of the ensemble.
java.lang.String	toString() Return a String representation of this Ensemble

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Ensemble

public Ensemble()

Create a new Ensemble

Method Detail

put

public Value put(java.lang.String qstr,
                 int vv,
                 java.lang.String uStr)

Pust a Quantity into the Ensemble.

Parameters:

qstr - quantity name

vv - quantity value

uStr - unit name

Returns:

the new Value or null if it is not already there

put

public Value put(Quantity qq,
                 Value vv)

Put a Quantity in the Ensemble

Parameters:

qq - Quantity

vv - Value

Returns:

vv or null if it is not already there

get

public Value get(Quantity qq)

Get the Value of a Quantity from the Ensemble

Parameters:

qq - Quantity to look up

Returns:

associated value

get

public Value get(java.lang.String qstr)

Get the Value from the Ensemble by Quantity name

Parameters:

qstr - quantity name

Returns:

associated value or null if it does not exist

isEmpty

public boolean isEmpty()

See if this ensemble is empty

Returns:

true if it has not entries

size

public int size()

Get the size of the ensemble.

Returns:

number of entries

keySet

public java.util.Set keySet()

Get the set of Quantitys in the Ensemble.

Returns:

set of Quantities

entrySet

public java.util.Set entrySet()

Get the set of Values in the Ensemble.

Returns:

set of Values

hashCode

public int hashCode()

Return the hash code for this object.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code

equals

public boolean equals(java.lang.Object oo)

See if the Object in question is equal to this Ensemble.

Overrides:

equals in class java.lang.Object

Parameters:

oo - Object in question

Returns:

true if they are equal

formatEntry

protected java.lang.StringBuffer formatEntry(java.lang.StringBuffer buf,
                                             java.util.Map.Entry entry)

Format the Entry.

Parameters:

buf - StringBuffer for formatting

entry - Entry to format

Returns:

formatted Entry

format

public java.lang.StringBuffer format(java.lang.StringBuffer buf)

Format the entire Ensemble. Iterates through all entries and returns the StringBuffer containing them.

Parameters:

buf - StringBuffer to put formatted entries into

Returns:

buf

toString

public java.lang.String toString()

Return a String representation of this Ensemble

Overrides:

toString in class java.lang.Object

Returns:

string representation