Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/digitalheir/java-xml-to-json
👾 convert XML to a structure-preserving JSON representation
https://github.com/digitalheir/java-xml-to-json
converter java json xml
Last synced: 2 days ago
JSON representation
👾 convert XML to a structure-preserving JSON representation
- Host: GitHub
- URL: https://github.com/digitalheir/java-xml-to-json
- Owner: digitalheir
- License: mit
- Created: 2015-11-18T22:42:08.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-04-14T19:21:49.000Z (almost 2 years ago)
- Last Synced: 2023-07-30T10:26:17.732Z (over 1 year ago)
- Topics: converter, java, json, xml
- Language: Java
- Homepage:
- Size: 91.8 KB
- Stars: 15
- Watchers: 4
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# XML to terse JSON
[](https://github.com/digitalheir/java-xml-to-json/releases/latest)
[](https://travis-ci.org/digitalheir/java-xml-to-json)
This is a project to convert XML documents to JSON. It does this by taking a disciplined approach
to create a terse JSON structure. The library has support for node types such as comments and processing instructions.
DTDs are experimentally supported (a node will be created for them),
but entity references are unpacked, i.e., `<` in XML becomes `<` in JSON.
## Motivation
There are a bunch of libraries out there that convert, most notably in [`org.json.XML`](http://www.json.org/javadoc/org/json/XML.html).
The problem with most XML-to-JSON implementations is that we lose a lot of information about ordering / attributes / whatever.
Another motivation was to have a more light-weight JSON serialization of XML, since lossless transformations
[tend to be wordy](https://github.com/digitalheir/ruby-xml-to-json). In this library, we
trade off some readability for a reduction in bytes. JSON output for this library is typically only slightly larger in bytesize
than the XML input.
## Usage
Download [the latest JAR](https://github.com/digitalheir/java-xml-to-json/releases/latest) or grab from Maven:
```xml
org.leibnizcenter
xml-to-json
0.9.2
```
or Gradle:
```groovy
compile 'org.leibnizcenter:xml-to-json:0.9.2'
```
```java
import com.google.gson.Gson;
import org.leibnizcenter.xml.helpers.DomHelper;
import org.leibnizcenter.xml.NotImplemented;
import org.leibnizcenter.xml.TerseJson;
import org.w3c.dom.Document;
import org.xml.sax.SAXException;
import javax.xml.parsers.ParserConfigurationException;
import java.io.IOException;
public class Main {
private static final TerseJson.WhitespaceBehaviour COMPACT_WHITE_SPACE = TerseJson.WhitespaceBehaviour.Compact;
public static void main(String[] args) throws IOException, SAXException, ParserConfigurationException, NotImplemented {
String xml = ("" +
"" +
" " +
" " +
" " +
"");
// Parse XML to DOM
Document doc = DomHelper.parse(xml);
// Convert DOM to terse representation, and convert to JSON
TerseJson.Options opts = TerseJson.Options
.with(COMPACT_WHITE_SPACE)
.and(TerseJson.ErrorBehaviour.ThrowAllErrors);
Object terseDoc = new TerseJson(opts).convert(doc);
String json = new Gson().toJson(terseDoc);
System.out.println(json);
}
}
```
produces
```json
[9,[{"1":"root","3":[[8," thïs ïs à cómmënt. "]," ",{"1":"el","2":[["ampersand"," a \u0026 b"]],"3":[" ",{"1":"selfClosing"}," "]}]}]]
```
## Details
### JavaDoc
JavaDoc is available at https://digitalheir.github.io/java-xml-to-json/
### Node types
```json
var nodeTypes = {
1: "element",
2: "attribute",
3: "text",
4: "cdata_section",
5: "entity_reference",
6: "entity",
7: "processing_instruction",
8: "comment",
9: "document",
10: "document_type",
11: "document_fragment",
12: "notation"
}
```
### Utility functions
```js
var getChildren = function (node) {
if (node[0].match(/element|document/) {
return node[1];
} else {
return undefined;
}
};
var getName = function (node) {
if (node[0].match(/element/)){
return node[2];
} else if(typeof node[0]==="string"){
return node[0];
} else{
return undefined;
}
}
```
### Document
Translates to a fixed length JSON array:
|index|type|description|
|---|---|---|
|0|int|[9](#node-types)|
|1|array|Children; can be any JSON element|
### Element
Translates to a variable length JSON array:
|index|type|description|
|---|---|---|
|0|int|[1](#node-types)|
|1|String|tag name|
|2|array|children as any JSON element; may be missing if element does not have children **and** no attributes|
|3|array|attributes as [key, value]; may be missing if element does not have attributes|
### Attribute
Translates to a fixed length JSON array:
|index|type|description|
|---|---|---|
|0|String|attribute name|
|1|String|attribute value|
### Text
Text nodes are converted to JSON strings
### Comment
Translates to a fixed length JSON array:
|index|type|description|
|---|---|---|
|0|int|[8](#node-types)|
|1|String|Comment text|
### CDATA
Translates to a fixed length JSON array:
|index|type|description|
|---|---|---|
|0|int|[4](#node-types)|
|1|String|attribute value|
### Processing instruction
Translates to a fixed length JSON array:
|index|type|description|
|---|---|---|
|0|targ|[7](#node-types)|
|1|String|target|
|2|String|content|
### Entity Reference
Not yet implemented
### Entity
Not yet implemented
### Document type
Not yet implemented
### Document fragment
Not yet implemented
### Notation
Not yet implemented