ucar.unidata.view.sounding
Class Readout

java.lang.Object
  ucar.unidata.view.sounding.Readout

All Implemented Interfaces:

PropertyChangeListener, EventListener

public class Readout
extends Object
implements PropertyChangeListener

Provides support for value readouts.

Version:

$Id: Readout.java,v 1.12 2005/05/13 18:33:36 jeffmc Exp $

Author:

Steven R. Emmerson

Field Summary

static String	NAME The name of the name property.
static String	NUMERIC_STRING The name of the numeric-string property.
static int	REAL_UNIT The indicator for using the unit of the Real.
static int	REALTYPE_NAME The indicator for using the name of the RealType.
static int	REALTYPE_UNIT The indicator for using the unit of the RealType.
static int	SPECIFIED_NAME The indicator for using the client-supplied name.
static int	SPECIFIED_UNIT The indicator for using the unit supplied by the client.
static String	UNIT_STRING The name of the unit-string property.

Constructor Summary

Readout()
Constructs from nothing.

Method Summary

void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Adds a PropertyChangeListener for a named property.
String	getName() Returns the name of the readout.
protected String	getName(Real real) Returns the name of the given Real, given the current name-use mode.
Component	getNameComponent() Returns the name component.
int	getNameUse() Returns the type of name-use.
String	getNumericString() Returns the numeric string of the readout.
protected String	getNumericString(Real real) Returns the numeric-string of the given Real, given the current unit-use mode.
Component	getNumericValueComponent() Returns the numeric-value component.
String	getSpecifiedName() Returns the client-supplied name for the readout.
String	getSpecifiedUnit() Returns the client-supplied unit-specification.
Component	getUnitComponent() Returns the unit-specification component.
String	getUnitString() Returns the unit-specification of the readout.
protected String	getUnitString(Real real) Returns the unit-specification of the given Real, given the current unit-use mode.
int	getUnitUse() Returns the type of unit-use.
void	propertyChange(PropertyChangeEvent event) Handles a change to a property.
void	setNameUse(int which) Sets the type of name-use.
void	setSpecifiedName(String name) Sets the client-supplied name for the readout.
void	setSpecifiedUnit(String unitString) Sets the client-supplied unit-specification.
void	setUnitUse(int which) Sets the type of unit-use.

Methods inherited from class java.lang.Object

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

Field Detail

REALTYPE_NAME

public static final int REALTYPE_NAME

The indicator for using the name of the RealType.

See Also:

Constant Field Values

SPECIFIED_NAME

public static final int SPECIFIED_NAME

The indicator for using the client-supplied name.

See Also:

Constant Field Values

REAL_UNIT

public static final int REAL_UNIT

The indicator for using the unit of the Real.

See Also:

Constant Field Values

REALTYPE_UNIT

public static final int REALTYPE_UNIT

The indicator for using the unit of the RealType.

See Also:

Constant Field Values

SPECIFIED_UNIT

public static final int SPECIFIED_UNIT

The indicator for using the unit supplied by the client.

See Also:

Constant Field Values

NAME

public static final String NAME

The name of the name property.

See Also:

Constant Field Values

NUMERIC_STRING

public static final String NUMERIC_STRING

The name of the numeric-string property.

See Also:

Constant Field Values

UNIT_STRING

public static final String UNIT_STRING

The name of the unit-string property.

See Also:

Constant Field Values

Constructor Detail

Readout

public Readout()

Constructs from nothing.

Method Detail

setSpecifiedName

public void setSpecifiedName(String name)

Sets the client-supplied name for the readout.

Parameters:

name - The client-supplied name for the readout.

getSpecifiedName

public String getSpecifiedName()

Returns the client-supplied name for the readout.

Returns:

The client-supplied name for the readout.

setNameUse

public void setNameUse(int which)

Sets the type of name-use.

Parameters:

which - The type of name-use. One of REALTYPE_NAME or SPECIFIED_NAME.

getNameUse

public int getNameUse()

Returns the type of name-use.

Returns:

The type of name-use. One of REALTYPE_NAME or SPECIFIED_NAME.

setSpecifiedUnit

public void setSpecifiedUnit(String unitString)
                      throws NoSuchUnitException,
                             ParseException

Sets the client-supplied unit-specification.

Parameters:

unitString - The client-supplied unit-specification.

Throws:

NoSuchUnitException - if the specification couldn't be decoded.

ParseException - if the specification couldn't be parsed.

getSpecifiedUnit

public String getSpecifiedUnit()

Returns the client-supplied unit-specification.

Returns:

The client-supplied unit-specification.

setUnitUse

public void setUnitUse(int which)

Sets the type of unit-use.

Parameters:

which - The type of unit-use. One of REAL_UNIT, REALTYPE_UNIT, or SPECIFIED_UNIT.

getUnitUse

public int getUnitUse()

Returns the type of unit-use.

Returns:

The type of unit-use. One of REAL_UNIT, REALTYPE_UNIT, or SPECIFIED_UNIT.

getName

public String getName()

Returns the name of the readout.

Returns:

The name of the readout.

getNumericString

public String getNumericString()
                        throws VisADException

Returns the numeric string of the readout.

Returns:

The numeric string of the readout.

Throws:

VisADException - if a core VisAD failure occurs.

getUnitString

public String getUnitString()

Returns the unit-specification of the readout.

Returns:

The unit-specification of the readout.

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener listener)

Adds a PropertyChangeListener for a named property.

Parameters:

propertyName - The name of the property.

listener - The PropertyChangeListener to be added.

propertyChange

public void propertyChange(PropertyChangeEvent event)

Handles a change to a property.

Specified by:

propertyChange in interface PropertyChangeListener

Parameters:

event - The property change event.

getNameComponent

public Component getNameComponent()

Returns the name component.

Returns:

The name component.

getNumericValueComponent

public Component getNumericValueComponent()

Returns the numeric-value component.

Returns:

The numeric-value component.

getUnitComponent

public Component getUnitComponent()

Returns the unit-specification component.

Returns:

The unit-specification component.

getName

protected String getName(Real real)

Returns the name of the given Real, given the current name-use mode.

Parameters:

real - The Real to have a name returned.

Returns:

The name of the Real given the current name-use mode.

getNumericString

protected String getNumericString(Real real)

Returns the numeric-string of the given Real, given the current unit-use mode.

Parameters:

real - The Real to have a numeric-string returned.

Returns:

The numeric-string of the Real given the current unit-use mode.

getUnitString

protected String getUnitString(Real real)

Returns the unit-specification of the given Real, given the current unit-use mode.

Parameters:

real - The Real to have a unit-specification returned.

Returns:

The unit-specification of the Real given the current unit-use mode.