Packageorg.spicefactory.lib.xml.mapper
Classpublic class AbstractXmlObjectMapper
InheritanceAbstractXmlObjectMapper Inheritance Object
Implements XmlObjectMapper
Subclasses PropertyMapper, SimpleValueMapper

Base class for XmlObjectMapper implementations providing default implementations for the two property getter methods. The two actual mapping methods are not implemented by this base class.



Public Properties
 PropertyDefined By
  elementName : QName
[read-only] The name of the elements the mapToXml method produces.
AbstractXmlObjectMapper
  objectType : ClassInfo
[read-only] The type of the objects the mapToObject method produces.
AbstractXmlObjectMapper
Public Methods
 MethodDefined By
  
AbstractXmlObjectMapper(objectType:ClassInfo, elementName:QName)
Creates a new instance.
AbstractXmlObjectMapper
  
mapToObject(element:XML, context:XmlProcessorContext = null):Object
Maps from XML to object.
AbstractXmlObjectMapper
  
mapToXml(object:Object, context:XmlProcessorContext = null):XML
Maps from object to XML.
AbstractXmlObjectMapper
Property Detail
elementNameproperty
elementName:QName  [read-only]

The name of the elements the mapToXml method produces.


Implementation
    public function get elementName():QName
objectTypeproperty 
objectType:ClassInfo  [read-only]

The type of the objects the mapToObject method produces.


Implementation
    public function get objectType():ClassInfo
Constructor Detail
AbstractXmlObjectMapper()Constructor
public function AbstractXmlObjectMapper(objectType:ClassInfo, elementName:QName)

Creates a new instance.

Parameters
objectType:ClassInfo — the type of the mapped object
 
elementName:QName — the name of the mapped XML element
Method Detail
mapToObject()method
public function mapToObject(element:XML, context:XmlProcessorContext = null):Object

Maps from XML to object. Should always return objects of the type the objectType property was set to.

Parameters

element:XML — the XML element to be transformed to an object
 
context:XmlProcessorContext (default = null) — the processing context

Returns
Object — a new object that maps to the specified XML element
mapToXml()method 
public function mapToXml(object:Object, context:XmlProcessorContext = null):XML

Maps from object to XML. Should always return XML elements with the name the elementName property was set to.

Parameters

object:Object — the object to be transformed to an XML element
 
context:XmlProcessorContext (default = null) — the processing context

Returns
XML — a new XML element that maps to the specified object