Package net.officefloor.plugin.xml.unmarshall.tree

Class XmlContext

java.lang.Object

net.officefloor.plugin.xml.unmarshall.tree.XmlContext

public class XmlContext
extends java.lang.Object

Context for XML unmarshalling to target object.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map<java.lang.String,ElementXmlMapping>	mappings	Mappings of XML element to appropriate ElementXmlMapping.

Constructor Summary

Constructors

Modifier	Constructor	Description
	XmlContext(java.lang.Class<?> targetObjectType, java.lang.String rootNode, XmlMappingMetaData[] configuration, TranslatorRegistry translatorRegistry, ReferencedXmlMappingRegistry referencedRegistry)	Constructor that should be used by external classes to instantiate this.
protected	XmlContext(java.lang.Class<?> targetObjectType, XmlMappingMetaData[] configuration, TranslatorRegistry translatorRegistry, java.lang.String outerElementName, XmlContext outerContext, ReferencedXmlMappingRegistry referencedRegistry)	Initiate the XmlContext from configuration.

Method Summary

Modifier and Type	Method	Description
ElementXmlMapping	getElementXmlMapping(java.lang.String elementName)	Obtains the ElementXmlMapping for the element.

Methods inherited from class java.lang.Object

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

Field Detail

mappings

protected final java.util.Map<java.lang.String,ElementXmlMapping> mappings

Mappings of XML element to appropriate ElementXmlMapping.

Constructor Detail

XmlContext

public XmlContext(java.lang.Class<?> targetObjectType,
                  java.lang.String rootNode,
                  XmlMappingMetaData[] configuration,
                  TranslatorRegistry translatorRegistry,
                  ReferencedXmlMappingRegistry referencedRegistry)
           throws XmlMarshallException

Constructor that should be used by external classes to instantiate this.

Parameters:

targetObjectType - Class of the target object.

rootNode - Name of root node to begin XML unmarshalling.

configuration - Configuration of this XmlContext.

translatorRegistry - Registry of translators for value translation.

referencedRegistry - Registry of referenced XmlMapping instances.

Throws:

XmlMarshallException - Should this XmlContext fail to be configured.

XmlContext

protected XmlContext(java.lang.Class<?> targetObjectType,
                     XmlMappingMetaData[] configuration,
                     TranslatorRegistry translatorRegistry,
                     java.lang.String outerElementName,
                     XmlContext outerContext,
                     ReferencedXmlMappingRegistry referencedRegistry)
              throws XmlMarshallException

Initiate the XmlContext from configuration.

Parameters:

targetObjectType - Class of the target object.

configuration - Configuration of this XmlContext.

translatorRegistry - Registry of translators for value translation.

outerElementName - Element name of outer context to enable mapping attributes onto appropriate context.

outerContext - Outer XmlContext to map attributes on.

referencedRegistry - Registry of referenced XmlMapping instances.

Throws:

XmlMarshallException - Should this XmlContext fail to be configured.

Method Detail

getElementXmlMapping

public ElementXmlMapping getElementXmlMapping(java.lang.String elementName)

Obtains the ElementXmlMapping for the element.

Parameters:

elementName - Element name.

Returns:

ElementXmlMapping for element or null if there is no mapping.