Icontem

JS Merge XML: Merge XML documents from strings or DOM objects

Recommend this page to a friend!

  Author Author  
Name: Vallo Reima <contact>
Classes: 6 packages by
Country: Estonia Estonia
Age: ???
All time rank: 351 in Estonia Estonia
Week rank: 11 Up1 in Estonia Estonia Equal
Innovation award
Innovation award
Nominee: 4x

Winner: 1x


  Detailed description   Download Download .zip .tar.gz   Install with Composer Install with Composer  
This object can merge XML documents from strings, DOM objects or input files.

It can take a XML document from a string or a DOM object tree, or a file taken from a form input and merges with another XML document.

The resulting document can be search using a XPath query string or returned as a string or a DOM object.

This object provides options to control whether the nodes with the same path or name are replaced or added sequentially.

Details
{startverticalbanner}
JS MergeXML [![npm version](https://badge.fury.io/js/mergexml.svg)](https://badge.fury.io/js/mergexml)
==================

MergeXML merges the XML sources (files, strings, objects) into single DOM XML object.
The merging is performed recursively on the node level adding new elements and replacing existing ones.
The nodes with the same path/name are replaced/added sequentially and the modification can be controlled by the options.

MergeXML could be useful in cases where it is necessary to gather XML data from multiple sources.
For example, to combine configuration files of different subsystems depending on the application logic. 

Main browsers (Chrome, Edge, IE, Firefox, Safari, Opera) and NodeJS (see below) are supported. The MergeXML is realized also in PHP (see [php-merge-xml]).

The usage
-----
MergeXML class can be included:

1. loading as a CommonJS module:

**`const MergeXML = require('./mergexml');`**

2. as a global script:

**`<script src="mergexml.js"></script>`**

The class instantiation:

>var oMX = new MergeXML([opts]);

or loading and instantiating at once:

>const oMX = new (require('./mergexml.js'))([opts]);

**opts** - the options object:

- join - common root name if any source has different root name (default is *root*, specifying *false* denies different names)
- updn - traverse the nodes by name sequence (*true*, default) or overall sequence (*false*)
- stay - the *stay* attribute value to deny overwriting of specific node (default is *all*, can be array of values or empty)
- path - require path to NodeJS modules (default is looking from *node_modules*, N/A for browsers)

**oMX.AddSource(source)**;

> source - XML string or DOM object

**oMX.AddFile(elem)**;

> elem - FileList element of the XML file (browsers only)

The methods merge a sequent source and return the final object or *false* if failed (see *error* property below).

**oMX.Init([opts])**;

Clear existing result to restart.
> opts - the options object as above (except *path*)

You can search in the result object:

**oMX.Query(expr)**;

> expr - XPath query expression

You can get the XML result tree:

**oMX.Get([0|1|2])**;

- 0 - object (default)
- 1 - text
- 2 - html


The result object can be accessed also via *oMX.dom* property. The properties available:

- **dom** - result XML DOM object (in older IE browsers this is an ActiveX Object, not a standard XML Document)
- **nsp** - namespaces list object (prefix:URI)
- **count** - number of sources merged
- **error** - error information
  - error.code ('' is ok)
  - error.text

The sources must have the same default namespace (if have at all).
Prefix '_' is reserved to handle the default namespace.
IE doesn't allow replacement of the root node attributes.

Installation
------------

Run from the appropriate directory:
>npm install mergexml

Or manually download the [js-merge-xml] package from Github and unzip the files into installation directory. 

Run the sample in your browser (**HTML5** compatible):

1. open *example.html*
2. choose the *xml* files to be merged (*test* folder)
3. click *Merge* button
4. the merged *xml* is displayed...

The tests
--------
To run the browsers' tests from the CLI:

1. go to installation directory 
2. install framework: `npm install --dev`
3. run the tests: `npm test`
4. the results are displayed...
5. to remove the test modules: `npm prune --prod`

NodeJS
------
The browser window objects' (*DOMParser, XPathEvaluator, XMLSerializer*) functionality is implemented by the *xpath, xmldom* modules as node global objects. The sample requires also the *formidable* module. 

Install the dependent modules:

>npm install --prod

Start NodeJS with the sample script:

>node examplen.js

Run the sample in your browser:

>http://localhost:3000

The package
------

The following files are included:

1. *mergexml.js* - MergeXML class supporting the browser and NodeJS environments;
2. *example.html* - multi-selects the xml files and displays result (browser);
3. *example.js* - passes the xml data and returns result (browser);
4. *examplen.htm* - client-side template to multi-select the xml files and display result (NodeJS);
5. *examplen.js* - server-side module to receive requests and response results (NodeJS);
6. *package.json, bower.json* - package details;
7. *test* - a folder with the (browser) testing files.

ChangeLog
---------

June/July 2015 (Martijn van de Rijdt)

- *mergexml.js*
  - the wrapper is added for a compatibility with the AMD/CommonJS-like environments
- *test*
  - automated browser tests
 
October 2016 (Martijn van de Rijdt)

- *mergexml.js*
  - cloning the namespaced attributes correctly
  - mixing sources of undeclared encoding

August 2019 (Vallo Reima)

- *mergexml.js*
  - NodeJS environment support
- *examplen.js, examplen.htm*
  - NodeJS usage sample
 
[php-merge-xml]: http://www.github.com/hareko/php-merge-xml
[js-merge-xml]: http://www.github.com/hareko/js-merge-xml

  Classes of Vallo Reima  >  JS Merge XML  >  Download Download .zip .tar.gz  >  Support forum Support forum (1)  >  Blog Blog  >  RSS 1.0 feed RSS 2.0 feed Latest changes  
Name: JS Merge XML
Base name: merge-xml
Description: Merge XML documents from strings or DOM objects
Version: 1.1.8
JavaScript version: 1.4
License: BSD License
All time users: 117 users
All time rank: 386
Week users: 0 users
Week rank: 4 Equal
 
  Groups   Rate classes User ratings   Applications   Files Files  

  Groups  
Group folder image XML XML parsing and generation View top rated classes


  Innovation Award  
JavaScript Programming Innovation award nominee
May 2014
Number 6
In JavaScript it is easy to create and parse XML documents using the DOM support built-in all browsers.

This object extends that support by making it easier to merge XML nodes from multiple documents.

Manuel Lemos

  User ratings  
Not enough user ratings

  Applications that use this package  
No pages of applications that use this class were specified.

Add link image If you know an application of this package, send a message to the author to add a link here.

  Files folder image Files  
File Role Description
Files folder imagetest (2 files)
Accessible without login Plain text file bower.json Data Auxiliary data
Accessible without login Plain text file example.html Example Sample output
Accessible without login Plain text file example.js Example Example script
Accessible without login HTML file examplen.htm Doc. Documentation
Accessible without login Plain text file examplen.js Example Example script
Accessible without login Plain text file LICENSE Doc. Documentation
Plain text file mergexml.js Class Class source
Accessible without login Plain text file package-lock.json Data Auxiliary data
Accessible without login Plain text file package.json Data Auxiliary data
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files  /  test  
File Role Description
  Accessible without login Plain text file test1.xml Data Auxiliary data
  Accessible without login Plain text file test2.xml Data Auxiliary data

Install with Composer Install with Composer - Download Download all files: merge-xml.tar.gz merge-xml.zip
NOTICE: if you are using a download manager program like 'GetRight', please Login before trying to download this archive.