|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.codestreet.messageforge.RFld com.codestreet.messageforge.RFldMoney
Class to represent a Money field. The motivation and implementation of this data type comes from the book Patterns of Enterprise Application Architecture by Martin Fowler.
Field Summary | |
protected static java.lang.String |
XML_TAG
XML tag for this element type. |
Fields inherited from class com.codestreet.messageforge.RFld |
desc_, fieldId_, locked_, name_, optional_, propertyName_, tags_, transient_, valSet_ |
Constructor Summary | |
RFldMoney()
Default constructor. |
|
RFldMoney(java.lang.String name,
int fieldId)
Constructor. |
|
RFldMoney(java.lang.String name,
int fieldId,
java.lang.String desc)
Constructor. |
Method Summary | |
void |
addConstraint(RFldConstraintString cons)
Add a constraint. |
boolean |
equals(java.lang.Object anObject)
Check if another field is equal to this field. |
java.lang.String |
getTag()
Get the XML tag for this field type. |
RFldType |
getType()
Get field type. |
RMoney |
getValue()
Get data. |
java.util.Hashtable |
getValueAsHashtable()
Get the field value as a java.util.Hashtable. |
java.lang.Object |
getValueAsObject()
Get the field value as an object. |
java.lang.String |
getValueAsString()
Get the field value as a string. |
int |
hashCode()
Returns a hash code value for the field. |
void |
reset()
Reset the field value. |
RFld |
set(org.jdom.Element elem)
Set the field value from a JDOM element. |
RFld |
set(long newData)
Set data. |
RFld |
set(java.lang.Object newData)
Set data. |
RFld |
set(RMoney newData)
Set data. |
static void |
setTag(java.lang.String tag)
Set the XML tag for this field type. |
void |
validate()
Validate against constraints. |
void |
validate(RMoney newData)
Check if a new value will satifsy constraints. |
Methods inherited from class com.codestreet.messageforge.RFld |
addConstraint, buildMinMaxConstraintKey, getConstraint, getConstraintCount, getDesc, getId, getName, getOptional, getPropertyName, getTags, getTransient, isConstrained, isLocked, isProperty, isValSet, marshal, marshal, setId, setLocked, setName, setOptional, setPropertyName, setTags, setTransient, setXmlAttrNames, setXmlTags |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static transient java.lang.String XML_TAG
Constructor Detail |
public RFldMoney()
public RFldMoney(java.lang.String name, int fieldId)
name
- Field name.fieldId
- Field id. Field ids must be either 0 to indicate
that there is no id on the field, or greater. In addition,
field ids must be unique within a messages - no two fields
are allowed to have the same field id.public RFldMoney(java.lang.String name, int fieldId, java.lang.String desc)
name
- Field name.fieldId
- Field id. Field ids must be either 0 to indicate
that there is no id on the field, or greater. In addition,
field ids must be unique within a messages - no two fields
are allowed to have the same field id.desc
- Field description.Method Detail |
public final RFldType getType()
getType
in interface RFldInterface
getType
in class RFld
RFldType
public boolean equals(java.lang.Object anObject)
equals
in class RFld
anObject
- Another field.
public int hashCode()
hashCode
in class RFld
public void addConstraint(RFldConstraintString cons) throws FieldValidationException
cons
- Constraint.
FieldValidationException
public void reset() throws FieldValidationException
reset
in class RFld
FieldValidationException
RFld.isValSet()
public RFld set(java.lang.Object newData) throws FieldValidationException
set
in interface RFldInterface
set
in class RFld
newData
- New data.
FieldValidationException
public RFld set(long newData) throws FieldValidationException
newData
- New data. If the field value is already set then the
currency of thew new value is assumed to be same as that of the
present value. Otherwise, the currency is assumed to be USD.
FieldValidationException
public RFld set(RMoney newData) throws FieldValidationException
newData
- New data.
FieldValidationException
public final RFld set(org.jdom.Element elem) throws FieldValidationException
set
in interface RFldInterface
set
in class RFld
elem
- Field value as a JDOM element.
FieldValidationException
public void validate() throws FieldValidationException
validate
in class RFld
FieldValidationException
public void validate(RMoney newData) throws FieldValidationException
newData
- New value.
FieldValidationException
public RMoney getValue()
public java.lang.Object getValueAsObject()
public java.lang.String getValueAsString()
getValueAsString
in class RFld
public java.util.Hashtable getValueAsHashtable() throws FieldValidationException
FieldValidationException
public final java.lang.String getTag()
getTag
in class RFld
public static void setTag(java.lang.String tag)
tag
- New XML tag for this field type.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |