cookxml.common.creator
Class BaseCreator

java.lang.Object
  extended bycookxml.common.creator.BaseCreator
All Implemented Interfaces:
Creator

public class BaseCreator
extends Object
implements Creator

The purpose of this creator is to act as the document base such that whatever parentTag and parentObj information can be passed onto the current XML document. As the name implies, it is really only useful/necessary to be used as the document root.

Since:
CookXml 1.0

Method Summary
 Object create(String parentTag, Element elm, Object parentObj, String value, DecodeEngine decodeEngine)
          This function is called whenever decodeEngine starts processing an element.
 Object editFinished(String parentTag, Element elm, Object parentObj, Object obj, DecodeEngine decodeEngine)
          This function is called when the element and its subnodes have all been processed. and about to be returned.
static Creator getInstance()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static Creator getInstance()

create

public Object create(String parentTag,
                     Element elm,
                     Object parentObj,
                     String value,
                     DecodeEngine decodeEngine)
              throws CreatorException
Description copied from interface: Creator
This function is called whenever decodeEngine starts processing an element. It should return an object that corresponds to the tag, or null to indicate no object could be created. If the object returned is of NoAdd type, then the object is not added to the parent object by decodeEngine.

There can be creative use of this function. For example, one could create another instance of CookXml that process the element differently, then call this instanceof decodeEngine to add the processed object to the parent, and then return null to tell this instance of decodeEngine/CookXml to stop processing the element.

Specified by:
create in interface Creator
Parameters:
parentTag - the parent tag that contains this element
elm - the DOM element that contains all the information regarding this node.
parentObj - the parent object in the node
value - the string value specified in the constructor field
decodeEngine - the decode engine that is being used
Returns:
the object created, or null to tell decodeEngine to stop processing this node
Throws:
CreatorException

editFinished

public Object editFinished(String parentTag,
                           Element elm,
                           Object parentObj,
                           Object obj,
                           DecodeEngine decodeEngine)
                    throws CookXmlException
Description copied from interface: Creator
This function is called when the element and its subnodes have all been processed. and about to be returned. For many helper objects that implement NoAdd, this is a great time to generate the real object and call the decodeEngine.addChild to add the real object to the parent.

Specified by:
editFinished in interface Creator
Parameters:
parentTag - the parent element tag
elm - the DOM element that contains all the information regarding this node.
parentObj - the parent object of the parent element
obj - the object that was created by this create function
decodeEngine - the decode engine that is being used.
Returns:
the object. The purpose is to allow a helper object to return the real object.
Throws:
CookXmlException