Import xml and JSon with MDriven
No edit summary
(Automatically adding template at the end of the page.)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
I have discussed the ''selfVM.JsonToObjects'' a bit in [[Rest Services In MDriven|this article]]. I now introduce another similar function – the ''selfVM.XmlToObjects''.
I have discussed the ''selfVM.JsonToObjects'' a bit in [[Rest Services In MDriven|this article]]. I now introduce another similar function – the ''selfVM.XmlToObjects''.


Suppose you have a use case where you receive XML data – you want to turn this data into objects in your model for further processing.
Suppose you have a use case where you receive XML data. You want to turn this data into objects in your model for further processing.


I will walk through this with a mock sample.
I will walk through this with a mock sample.
Line 20: Line 20:
[[File:Import xml and JSon with MDrive 01.png|frameless|221x221px]]
[[File:Import xml and JSon with MDrive 01.png|frameless|221x221px]]


Now I expose this attribute in a ViewModel so that I can paste in the sample XML and get it into play:
Now, I expose this attribute in a ViewModel so that I can paste in the sample XML and get it into play:


[[File:Import xml and JSon with MDriven 02.png|frameless|620x620px]]
[[File:Import xml and JSon with MDriven 02.png|frameless|620x620px]]
Line 32: Line 32:
[[File:Import xml and JSon with MDriven 03.png|frameless|317x317px]]
[[File:Import xml and JSon with MDriven 03.png|frameless|317x317px]]


Notice that I have added an attribute ''RawJSon : String'' – this is totally optional but if this attribute exists on the class used as a target in ''selfVM.XmlToObjects'' or ''selfVM.JsonToObjects,'' then the handled JSon is assigned here (the imported Xml is first converted to JSon – then ''JsonToObjects'' handles the objects ) – this might be good for developing purposes.
Notice that I have added an attribute ''RawJSon : String'' – this is totally optional, but if this attribute exists on the class used as a target in ''selfVM.XmlToObjects'' or ''selfVM.JsonToObjects,'' then the handled JSon is assigned here (the imported Xml is first converted to JSon – then ''JsonToObjects'' handles the objects ) – this might be good for developing purposes.


Now we can add an action to call the ''selfVM.XmlToObjects'' :
Now we can add an action to call the ''selfVM.XmlToObjects'' :
Line 38: Line 38:
[[File:Import xml and JSon with MDriven 04.png|frameless|601x601px]]
[[File:Import xml and JSon with MDriven 04.png|frameless|601x601px]]


The expression for the button action is:
The expression for the button action is '''vNewImportFile:=selfVM.XmlToObjects(  ImportFile , self.XmlInput)'''
 
'''vNewImportFile:=selfVM.XmlToObjects(  ImportFile , self.XmlInput)'''


This means:
This means:
Line 46: Line 44:
* Create an object of class '''''ImportFile''''' as root
* Create an object of class '''''ImportFile''''' as root
* Assign the resulting object of '''''ImportFile''''' class to the variable '''''vNewImportFile'''''
* Assign the resulting object of '''''ImportFile''''' class to the variable '''''vNewImportFile'''''
Running it in the prototyper gives us:
Running it in the Prototyper gives us:


[[File:Import xml and JSon with MDriven 05.png|frameless|608x608px]]
[[File:Import xml and JSon with MDriven 05.png|frameless|608x608px]]
Line 86: Line 84:
[[File:Import xml and JSon with MDriven 08.png|frameless|502x502px]]
[[File:Import xml and JSon with MDriven 08.png|frameless|502x502px]]


Running in the prototyper, I can see my XML is imported as objects in my model:
Running in the Prototyper, I can see my XML is imported as objects in my model:


[[File:Import xml and JSon with MDriven 09.png|frameless|508x508px]]
[[File:Import xml and JSon with MDriven 09.png|frameless|508x508px]]
Line 93: Line 91:
[[Category:View Model]]
[[Category:View Model]]
[[Category:OCL ViewModel Operators]]
[[Category:OCL ViewModel Operators]]
{{Edited|July|12|2024}}

Latest revision as of 15:35, 10 February 2024

I have discussed the selfVM.JsonToObjects a bit in this article. I now introduce another similar function – the selfVM.XmlToObjects.

Suppose you have a use case where you receive XML data. You want to turn this data into objects in your model for further processing.

I will walk through this with a mock sample.

I have this XML:

<?xml version='1.0' standalone='no'?>
 <root>
  <person id='1'>
    <name>Alan</name>
    <url>http://www.google.com</url>
  </person>  <person id='2'>
    <name>Louis</name>
    <url>http://www.yahoo.com</url>
  </person>
 </root> 

I add a Text attribute to a class:

Import xml and JSon with MDrive 01.png

Now, I expose this attribute in a ViewModel so that I can paste in the sample XML and get it into play:

Import xml and JSon with MDriven 02.png

Running the model, I create an object and paste it in XML in the XmlInput attribute.

Import xml and JSon with MDriven 10.png

Where should the information end up? I add a new class for this:

Import xml and JSon with MDriven 03.png

Notice that I have added an attribute RawJSon : String – this is totally optional, but if this attribute exists on the class used as a target in selfVM.XmlToObjects or selfVM.JsonToObjects, then the handled JSon is assigned here (the imported Xml is first converted to JSon – then JsonToObjects handles the objects ) – this might be good for developing purposes.

Now we can add an action to call the selfVM.XmlToObjects :

Import xml and JSon with MDriven 04.png

The expression for the button action is vNewImportFile:=selfVM.XmlToObjects(  ImportFile , self.XmlInput)

This means:

  • Use this Xml data: self.XmlInput
  • Create an object of class ImportFile as root
  • Assign the resulting object of ImportFile class to the variable vNewImportFile

Running it in the Prototyper gives us:

Import xml and JSon with MDriven 05.png

The Json looks like this:

{
  "?xml": {
    "@version": "1.0",    "@standalone": "no"
  },
  "root": {
    "person": [
      {
        "@id": "1",
        "name": "Alan",
        "url": "http://www.google.com"
      },
      {
        "@id": "2",
        "name": "Louis",
        "url": "http://www.yahoo.com"
      }
    ]
  }
 }

What we want to pay extra attention to in this JSon are things that can be used as associations and things that can be used as attributes. 

Import xml and JSon with MDriven 06.png

The red “root” looks like a single link, the green “person” as a multilink, and the blue ones are attributes on the objects that end up in the person association.

This tells me that I can do this:

Import xml and JSon with MDriven 07.png

Note that if the logic finds things in the input that it cannot find in your classes, it just silently continues. If your classes have more attributes or associations than what you have in the JSon data – that is fine as well. Also, note that your classes may have any name – it is the associations and attributes that are matched to understand data.

We can add UI to see the imported things:

Import xml and JSon with MDriven 08.png

Running in the Prototyper, I can see my XML is imported as objects in my model:

Import xml and JSon with MDriven 09.png

Mission accomplished.

This page was edited 98 days ago on 02/10/2024. What links here