com.ebm_ws.infra.xmlmapping.interfaces
Interface IXmlObject

public interface IXmlObject

This is the base interface to use the implicit XML mapping.

A class implementing this interface will be able through simple naming rules, to:

1. Instantiate automatically from an XML file,
2. Generate automatically its model schema (XSD).

Here are the naming rules:

• The tag name of the XML element corresponding to a class is its classname (without package).
• Field mapped to the (immediate) parent object:
  Naming rule: _xmlparent
• Field mapped to the (topmost) root object:
  Naming rule: _xmlroot
• A basic-typed field (int, boolean, float, String) should be mapped to an XML attribute.
  Naming rule: _xmlattr_[req|opt]_[<name>]
  ('req' means 'required', and 'opt' means 'optional')
• A string-typed field may be mapped to the XML element content.
  Naming rule: _xmlcontent
• To map a non-basic and single-typed (that supports implicit XML mapping too) field, you have 2 options:
  1. The corresponding child node will be the only child of a named child element.
     Naming rule: _xmlnode_[req|opt]_[<name>]
  2. Or the corresponding child node will be "collected" from the children.
     Naming rule: _xmlcollect_[req|opt]_[<name>]
• To map a non-basic and array-typed (that supports implicit XML mapping too) field, you have 2 options:
  1. The corresponding children nodes will be the only children of a named child element.
     Naming rule: _xmlnode_[<min(int)>]_[<max(int)>|unb]_[<name>]
     (<min> and <max> are positive integers that define the minimum and maximum size of the array. 'unb' means 'unbounded')
  2. Or the corresponding children node will be "collected" from the children.
     Naming rule: _xmlcollect_[<min(int)>]_[<max(int)>|unb]_[<name>]

Here is an example:

 // --- Class mapped to an XML element named 'MyNode'
 public class MyNode implements IXmlObject
 {
     // --- field mapped to the root object
     private MyRoot _xmlroot;
     // --- field mapped to the parent object
     private MyParent _xmlparent;
     
     // --- field mapped to mandatory string attribute with name 'ID'
     private String _xmlattr_req_ID;
     // --- field mapped to optional int attribute with name 'Length'
     private String _xmlattr_opt_Length;
     // --- field mapped to optional boolean attribute with name 'Bool'
     private String _xmlattr_opt_Bool;
     
     // --- field mapped to a mandatory child element in the child node with name 'Obj1'
     private MyInterface1 _xmlnode_req_Obj1;
     // --- field mapped to one or more children elements in the child node with name 'ArrayObj2'
     private MyInterface2[] _xmlnode_1_unb_ArrayObj2;
     // --- field mapped to one or two children elements right under the node
     private MyClass3[] _xmlcollect_1_2_ArrayObj3;
     
     public MyNode(XmlObject iParent, Element iNode, IInstanciationErrors iErrors)
     {
         super(iParent, iNode, iErrors);
     }
     [...]
 }
 

Such a class may be instantiated with the following XML:

 <MyRoot [...]>
   [...]
   <MyParent [...]>
     [...]
     <MyNode ID="node1" Length="12">
       <Obj1>
           <MyClass1 (implements MyInterface1) [...]>
               [...]
           </MyClass1>
       </Obj1>
       <ArrayObj2>
           <MyClass2a (implements MyInterface2) [...]>
               [...]
           </MyClass2a>
           <MyClass2b (implements MyInterface2) [...]>
               [...]
           </MyClass2b>
           <MyClass2a [...]>
               [...]
           </MyClass2b>
       </ArrayObj2>
       <MyClass3 [...]>
           [...]
       </MyClass3>
       <MyClass3 [...]>
           [...]
       </MyClass3>
     </MyNode>
     [...]
   </MyParent [...]>
   [...]
 </MyRoot [...]>
 

See Also:

XmlInstantiator, XsdGenerator

Method Summary

void	checkThisNode(java.lang.Object iValidSupport, IValidityLogger iErrors) This method is meant to check the validity of this object.

Method Detail

checkThisNode

void checkThisNode(java.lang.Object iValidSupport,
                   IValidityLogger iErrors)

This method is meant to check the validity of this object.
That is checking required resources exist, the model is coherent, ...

Parameters:

iValidSupport - Object that gives support for checking validity

iErrors - Object that allows logging validation errors.