com.codestreet.messageforge
Class RFldMsgObj

java.lang.Object
  com.codestreet.messageforge.RFld
      com.codestreet.messageforge.RFldMsgObj

All Implemented Interfaces:

RFldInterface, java.io.Serializable

public class RFldMsgObj

extends RFld

Class to represent a RMsg field.

Author:

Jawaid Hakim.

See Also:

Serialized Form

Field Summary

protected java.lang.Class	cls_
protected RMsg	dataObj_ Data.

Fields inherited from class com.codestreet.messageforge.RFld

desc_, fieldId_, locked_, name_, optional_, propertyName_, tags_, transient_, valSet_

Constructor Summary

RFldMsgObj()
Default constructor.

RFldMsgObj(java.lang.Class cls, java.lang.String name, int fieldId)
Constructor.

RFldMsgObj(java.lang.Class cls, java.lang.String name, int fieldId, java.lang.String desc)
Constructor.

Method Summary

boolean	equals(java.lang.Object anObject) Check if another field is equal to this field.
java.lang.Class	getClassObject() Get the Class of the data for this object.
java.lang.String	getTag() Get the XML tag for this field type.
RFldType	getType() Get field type.
RMsg	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 the hash code value for the field.
void	marshal(java.io.Writer writer, int indentLevel, java.lang.String indent, boolean newLines, boolean expandEmptyElements) Write the field as XML to target writer.
void	reset() Reset the field value.
RFld	set(org.jdom.Element elem) Set data.
RFld	set(java.lang.Object newData) Set data.
RFld	set(RMsg 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(RMsg 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, 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

dataObj_

protected RMsg dataObj_

Data.

cls_

protected java.lang.Class cls_

Constructor Detail

RFldMsgObj

public RFldMsgObj()

Default constructor.

RFldMsgObj

public RFldMsgObj(java.lang.Class cls,
                  java.lang.String name,
                  int fieldId)

Constructor.

Parameters:

cls - Class object of message object.

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.

RFldMsgObj

public RFldMsgObj(java.lang.Class cls,
                  java.lang.String name,
                  int fieldId,
                  java.lang.String desc)

Constructor.

Parameters:

cls - Class object of message object.

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

getType

public final RFldType getType()

Get field type.

Specified by:

getType in interface RFldInterface

Specified by:

getType in class RFld

Returns:

Field type MSGOBJ.

See Also:

RFldType

getClassObject

public java.lang.Class getClassObject()

Get the Class of the data for this object.

Returns:

Class of the data for this object.

equals

public boolean equals(java.lang.Object anObject)

Check if another field is equal to this field. Equality is defined as the fields having the same string representation. A short cut that needs to be fixed for cases where the string representation is rounding off numbers etc.

Specified by:

equals in class RFld

Parameters:

anObject - Another field.

Returns:

true if another field is equal to this field. Otherwise, returns false.

hashCode

public int hashCode()

Returns the hash code value for the field.

Specified by:

hashCode in class RFld

Returns:

Hash code value for the field.

reset

public void reset()
           throws FieldValidationException

Reset the field value.

Specified by:

reset in class RFld

Throws:

FieldValidationException

See Also:

RFld.isValSet()

set

public RFld set(java.lang.Object newData)
         throws FieldValidationException

Set data.

Specified by:

set in interface RFldInterface

Specified by:

set in class RFld

Parameters:

newData - New data.

Returns:

Reference to self so method chaining can be used.

Throws:

FieldValidationException

set

public RFld set(RMsg newData)
         throws FieldValidationException

Set data.

Parameters:

newData - New data.

Throws:

FieldValidationException

set

public final RFld set(org.jdom.Element elem)
               throws FieldValidationException

Set data.

Specified by:

set in interface RFldInterface

Specified by:

set in class RFld

Parameters:

elem - New data.

Returns:

Reference to self so method chaining can be used.

Throws:

FieldValidationException

validate

public void validate()
              throws FieldValidationException

Validate against constraints. A field is valid if either it's value is set and satisfies all constraints, or the the field is optional.

Specified by:

validate in class RFld

Throws:

FieldValidationException

validate

public void validate(RMsg newData)
              throws FieldValidationException

Check if a new value will satifsy constraints.

Parameters:

newData - New value.

Throws:

FieldValidationException

getValue

public RMsg getValue()

Get data.

Returns:

data Data.

getValueAsObject

public java.lang.Object getValueAsObject()

Get the field value as an object.

Returns:

Field value as an object. Reference to data is passed out so be very careful about modifying the data.

getValueAsString

public java.lang.String getValueAsString()

Get the field value as a string.

Specified by:

getValueAsString in class RFld

Returns:

Field value as a string. Returns null if the field value is not set.

getValueAsHashtable

public java.util.Hashtable getValueAsHashtable()
                                        throws FieldValidationException

Get the field value as a java.util.Hashtable.

Returns:

Field value as a java.util.Hashtable. If the value of the field has not been set then null is returned.

Throws:

FieldValidationException

marshal

public void marshal(java.io.Writer writer,
                    int indentLevel,
                    java.lang.String indent,
                    boolean newLines,
                    boolean expandEmptyElements)
             throws ConverterException

Write the field as XML to target writer.

Specified by:

marshal in interface RFldInterface

Overrides:

marshal in class RFld

Parameters:

writer - Output target.

indent - Indentation.

newLines - Newlines are inserted after each element if true.

expandEmptyElements - Empty elements - elements with no content - are expanded if true.

Throws:

ConverterException

getTag

public final java.lang.String getTag()

Get the XML tag for this field type.

Specified by:

getTag in class RFld

Returns:

XML tag for this field type.

setTag

public static void setTag(java.lang.String tag)

Set the XML tag for this field type.

Parameters:

tag - New XML tag for this field type.