org.dmd.dmc.types

Class LabelledIntegerDataPoint

java.lang.Object

org.dmd.dmc.types.LabelledIntegerDataPoint

All Implemented Interfaces:

Serializable, DmcMappedAttributeIF

public class LabelledIntegerDataPoint
extends Object
implements DmcMappedAttributeIF, Serializable

The LabelledDataPoint class allows for the representation of a single data point with a string label value and an integer value. An example would be "Apple Inc. 543". The label may have spaces, as long as the integer value is the final token.

This type is convenient for use in pie charts.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LabelledIntegerDataPoint()
LabelledIntegerDataPoint(LabelledIntegerDataPoint original)
LabelledIntegerDataPoint(String v) Constructs a new labelled data point.

Method Summary

Modifier and Type	Method and Description
void	deserializeIt(DmcInputStreamIF dis)
boolean	equals(Object v)
Object	getKey() Returns the key associated with this attribute value.
String	getKeyAsString() Returns the key value represented as a string.
String	getLabel()
int	getValue()
void	serializeIt(DmcOutputStreamIF dos)
void	set(String val)
String	toString()
boolean	valuesAreEqual(DmcMappedAttributeIF obj) This method is used by the Modifier mechanism to determine whether or not a change has occurred as a result of applying the modifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelledIntegerDataPoint

public LabelledIntegerDataPoint()

LabelledIntegerDataPoint

public LabelledIntegerDataPoint(LabelledIntegerDataPoint original)

LabelledIntegerDataPoint

public LabelledIntegerDataPoint(String v)
                         throws DmcValueException

Constructs a new labelled data point.

Parameters:

v - The string representation of the value.

Throws:

DmcValueException

Method Detail

serializeIt

public void serializeIt(DmcOutputStreamIF dos)
                 throws Exception

Throws:

Exception

deserializeIt

public void deserializeIt(DmcInputStreamIF dis)
                   throws Exception

Throws:

Exception

set

public void set(String val)
         throws DmcValueException

Throws:

DmcValueException

getLabel

public String getLabel()

getValue

public int getValue()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object v)

Overrides:

equals in class Object

getKey

public Object getKey()

Description copied from interface: DmcMappedAttributeIF

Returns the key associated with this attribute value.

Specified by:

getKey in interface DmcMappedAttributeIF

Returns:

The key value.

getKeyAsString

public String getKeyAsString()

Description copied from interface: DmcMappedAttributeIF

Returns the key value represented as a string. we could just call the toString() method on the Object, but having this forces you implement an appropriate String conversion method for the key.

Specified by:

getKeyAsString in interface DmcMappedAttributeIF

Returns:

A String.

valuesAreEqual

public boolean valuesAreEqual(DmcMappedAttributeIF obj)

Description copied from interface: DmcMappedAttributeIF

This method is used by the Modifier mechanism to determine whether or not a change has occurred as a result of applying the modifier. Having this method forces you to implement a value comparison function, as opposed to relying on you to remember to overload the equals method on your values. When the value is put in the map, we get back the existing value if the key already existed. The add() method will then call this function to determine if a change really took place; if this method returns false, we report the change (by passing back the new value), otherwise we return null from the add().

You should ensure that you compare both the key and the value in your comparison.

Specified by:

valuesAreEqual in interface DmcMappedAttributeIF

Parameters:

obj - Another mapped attribute.

Returns:

true if the value of this attribute matches the value of the object passed in and false otherwise.