Package com.cmobilecom.af.model.formdesign

Class FormDesignEncoder

java.lang.Object

com.cmobilecom.af.model.formdesign.FormDesignEncoder

public class FormDesignEncoder
extends java.lang.Object

FormDesign xml encoder/decoder.

Since:

4.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FormDesignEncoder(FormDesign formDesign)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	decodeDesignXml(boolean force, DataAccessUnit dataAccessUnit)	Decode form design XML and initialize object model.
void	decodeDesignXml(DataAccessUnit dataAccessUnit)	Decode XML to object model if not decoded yet.
void	encodeDesignXml()	Set formDesign XML by encoding object model.
protected FormDesign	getFormDesign()	Get the FormDesign to be encoded/decoded
protected void	postDecodeDesignXml(org.w3c.dom.Element formDesignElem)	postDecodeDesignXml: called after XML is decoded.
protected void	postEncodeDesignXml(org.w3c.dom.Element formDesignElem)	postEncodeDesignXml: called after XML is encoded.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormDesignEncoder

protected FormDesignEncoder(FormDesign formDesign)

Constructor. Instances are created by FormDesignBean only.

Parameters:

formDesign - the FormDesign to be encoded/decoded

Method Detail

getFormDesign

protected FormDesign getFormDesign()

Get the FormDesign to be encoded/decoded

Returns:

FormDesign instance

decodeDesignXml

public void decodeDesignXml(DataAccessUnit dataAccessUnit)
                     throws ParseException,
                            SystemException

Decode XML to object model if not decoded yet.

Parameters:

dataAccessUnit - the associated DataAccessUnit

Throws:

ParseException - throw if an XML parsing error occurs

SystemException - throw if any other error occurs

decodeDesignXml

public void decodeDesignXml(boolean force,
                            DataAccessUnit dataAccessUnit)
                     throws ParseException,
                            SystemException

Decode form design XML and initialize object model.

Parameters:

force - whether to decode the XML even if it has been decoded

dataAccessUnit - the associated DataAccessUnit

Throws:

ParseException - throw if an XML parsing error occurs

SystemException - throw if any other error occurs

postDecodeDesignXml

protected void postDecodeDesignXml(org.w3c.dom.Element formDesignElem)
                            throws SystemException

postDecodeDesignXml: called after XML is decoded. Subclass should override this method to do more decoding if necessary.

Parameters:

formDesignElem - formDesign doc root element, null if design xml is null.

Throws:

SystemException - throw if an error occurs

postEncodeDesignXml

protected void postEncodeDesignXml(org.w3c.dom.Element formDesignElem)
                            throws SystemException

postEncodeDesignXml: called after XML is encoded. Subclass should override this method to do more encoding if necessary.

Parameters:

formDesignElem - formDesign doc root element

Throws:

SystemException - throw if an error occurs

encodeDesignXml

public void encodeDesignXml()
                     throws SystemException

Set formDesign XML by encoding object model. It is the reverse of the processDesignXml.

Throws:

SystemException - throw if an error occurs