jgnash.engine
Class CommodityNode

java.lang.Object
  extended by jgnash.engine.StoredObject
      extended by jgnash.engine.CommodityNode
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<CommodityNode>
Direct Known Subclasses:
CurrencyNode, SecurityNode

public abstract class CommodityNode
extends StoredObject
implements java.lang.Comparable<CommodityNode>

Abstract class for representing a commodity

Version:
$Id$
Author:
Craig Cavanaugh
See Also:
Serialized Form

Field Summary
private  java.lang.String description
           
private  java.lang.String prefix
           
private  byte scale
           
private static long serialVersionUID
           
private  java.lang.String suffix
           
private  java.lang.String symbol
           
 
Constructor Summary
CommodityNode()
           
 
Method Summary
 int compareTo(CommodityNode node)
           
 boolean equals(java.lang.Object other)
          Default equals override
 java.lang.String getDescription()
           
 java.lang.String getPrefix()
           
 byte getScale()
           
 java.lang.String getSuffix()
           
 java.lang.String getSymbol()
           
 int hashCode()
          Override hashCode to use uuid
 boolean matches(CommodityNode other)
          Determines if given node matches this node.
 java.math.BigDecimal round(double value)
          Rounds a supplied double to the correct scale and returns a BigDecimal
 void setDescription(java.lang.String description)
           
 void setPrefix(java.lang.String prefix)
           
 void setScale(byte scale)
           
 void setSuffix(java.lang.String suffix)
           
 void setSymbol(java.lang.String symbol)
           
 java.lang.String toString()
           
 
Methods inherited from class jgnash.engine.StoredObject
clone, getUuid, isMarkedForRemoval, setMarkedForRemoval
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

symbol

private java.lang.String symbol

scale

private byte scale

prefix

private java.lang.String prefix

suffix

private java.lang.String suffix

description

private java.lang.String description
Constructor Detail

CommodityNode

public CommodityNode()
Method Detail

setScale

public void setScale(byte scale)

getScale

public byte getScale()

setSymbol

public void setSymbol(java.lang.String symbol)

getSymbol

public java.lang.String getSymbol()

setDescription

public void setDescription(java.lang.String description)

getDescription

public java.lang.String getDescription()

setPrefix

public void setPrefix(java.lang.String prefix)

getPrefix

public java.lang.String getPrefix()

setSuffix

public void setSuffix(java.lang.String suffix)

getSuffix

public java.lang.String getSuffix()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

compareTo

public int compareTo(CommodityNode node)
Specified by:
compareTo in interface java.lang.Comparable<CommodityNode>

equals

public boolean equals(java.lang.Object other)
Description copied from class: StoredObject
Default equals override

Overrides:
equals in class StoredObject
Parameters:
other - object to compare
See Also:
Object.equals(java.lang.Object)

hashCode

public int hashCode()
Description copied from class: StoredObject
Override hashCode to use uuid

Overrides:
hashCode in class StoredObject
See Also:
Object.hashCode()

matches

public boolean matches(CommodityNode other)
Determines if given node matches this node. The UUID is not used for comparison if equals fails

Parameters:
other - CurrencyNode to compare against
Returns:
true if objects match

round

public java.math.BigDecimal round(double value)
Rounds a supplied double to the correct scale and returns a BigDecimal

Parameters:
value - double to round
Returns:
properly scaled BigDecimal