orienteering-oss / iof-xml Goto Github PK

View Code? Open in Web Editor NEW

1.0 1.0 0.0 6.82 MB

Java classes generated from IOF XSD v3 and v2

Home Page: https://orienteering-oss.github.io/iof-xml

License: GNU General Public License v3.0

Java 97.85% Kotlin 2.15%

iof orienteering unmarshalling xml-parser

iof-xml's People

Contributors

Stargazers

Watchers

iof-xml's Issues

Consider using 'mbknor-jackson-jsonSchema'

Today we are using FasterXML/jackson-module-jsonSchema, which works well, but does not support JSON Schema spec other than v3.

mbknor/mbknor-jackson-jsonSchema does also support newer versions of JSON Schema.

Consider using javadoc.io for JavaDoc generation

To get JavaDoc for multiple versions https://javadoc.io/doc/io.github.orienteering-oss/iofXml/latest/index.html may be better suited than today's solution.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

chore(deps): update dependency gradle to v8.10
fix(deps): update dependency org.junit:junit-bom to v5.11.0

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

chore(deps): update gradle/actions action to v4

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

chore(deps): update dependency java-jdk to v22

Detected dependencies

github-actions

.github/workflows/build-and-test.yml

actions/checkout v4

actions/setup-java v4

gradle/actions v3

.github/workflows/docs.yml

actions/checkout v4

actions/setup-java v4

peaceiris/actions-gh-pages v4

gradle

gradle.properties

settings.gradle

build.gradle

org.jetbrains.dokka 1.9.20

org.jetbrains.kotlin.jvm 2.0.10

org.glassfish.jaxb:jaxb-xjc 4.0.5

org.glassfish.jaxb:jaxb-runtime 4.0.5

org.glassfish.jaxb:jaxb-runtime 4.0.5

org.glassfish.jaxb:jaxb-runtime 4.0.5

jakarta.xml.bind:jakarta.xml.bind-api 4.0.2

com.fasterxml.jackson.module:jackson-module-jsonSchema 2.17.2

org.junit:junit-bom 5.10.3

gradle-wrapper

gradle/wrapper/gradle-wrapper.properties

gradle 8.9

regex

.github/workflows/build-and-test.yml

java-jdk 21.0.4+7.0.LTS

Check this box to trigger a request for Renovate to run again on this repository

Create tests for IOF v2 unmarshal functions

Fill these with meaningful content:

iof-xml/src/test/kotlin/iofXml/V2MarshallersKtTest.kt

Lines 22 to 65 in 8899ecf

 @Test 

 fun unmarshalIofV2PersonList() { 

 } 

 @Test 

 fun unmarshalIofV2CompetitorList() { 

 } 

 @Test 

 fun unmarshalIofV2RankList() { 

 } 

 @Test 

 fun unmarshalIofV2ClubList() { 

 } 

 @Test 

 fun unmarshalIofV2EventList() { 

 } 

 @Test 

 fun unmarshalIofV2ServiceRequestList() { 

 } 

 @Test 

 fun unmarshalIofV2EntryList() { 

 } 

 @Test 

 fun unmarshalIofV2StartList() { 

 } 

 @Test 

 fun unmarshalIofV2ResultList() { 

 } 

 @Test 

 fun unmarshalIofV2ClassData() { 

 } 

 @Test 

 fun unmarshalIofV2CourseData() { 

 } 

 }

Create marshal function for IOF v2 objects

Should be pretty equal to how v3 objects are marshalled:

iof-xml/src/main/kotlin/iofXml/V3Marshallers.kt

Lines 12 to 22 in 8899ecf

 /** 

  * Convert an object of IOF V3 type to XML string 

  */ 

 fun marshallIofV3(obj: Any, prettyPrint: Boolean = true): String { 

 val jaxbContext: JAXBContext = JAXBContext.newInstance(obj.javaClass) 

 val jaxbMarshaller = jaxbContext.createMarshaller() 

 jaxbMarshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, prettyPrint) 

 val writer = StringWriter() 

 jaxbMarshaller.marshal(obj, writer) 

 return writer.toString() 

 }

Remember to create a corresponding test in https://github.com/orienteering-oss/iof-xml/blob/main/src/test/kotlin/iofXml/V2MarshallersKtTest.kt

Convert XML to JSON

Would it be a nice feature to make it possible to convert an XML file to a JSON file? This could be done by unmarshal the XML document, and then marshal back into JSON.

This may be better suited for another project to keep the functionality of this project clean.

orienteering-oss / iof-xml Goto Github PK

iof-xml's People

Contributors

Stargazers

Watchers

iof-xml's Issues

Consider using 'mbknor-jackson-jsonSchema'

Consider using javadoc.io for JavaDoc generation

Dependency Dashboard

Awaiting Schedule

Open

Ignored or Blocked

Detected dependencies

Create tests for IOF v2 unmarshal functions

Create marshal function for IOF v2 objects

Convert XML to JSON

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

Jobs

	@Test
	fun unmarshalIofV2PersonList() {
	}

	@Test
	fun unmarshalIofV2CompetitorList() {
	}

	@Test
	fun unmarshalIofV2RankList() {
	}

	@Test
	fun unmarshalIofV2ClubList() {
	}

	@Test
	fun unmarshalIofV2EventList() {
	}

	@Test
	fun unmarshalIofV2ServiceRequestList() {
	}

	@Test
	fun unmarshalIofV2EntryList() {
	}

	@Test
	fun unmarshalIofV2StartList() {
	}

	@Test
	fun unmarshalIofV2ResultList() {
	}

	@Test
	fun unmarshalIofV2ClassData() {
	}

	@Test
	fun unmarshalIofV2CourseData() {
	}
	}

	/**
	* Convert an object of IOF V3 type to XML string
	*/
	fun marshallIofV3(obj: Any, prettyPrint: Boolean = true): String {
	val jaxbContext: JAXBContext = JAXBContext.newInstance(obj.javaClass)
	val jaxbMarshaller = jaxbContext.createMarshaller()
	jaxbMarshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, prettyPrint)
	val writer = StringWriter()
	jaxbMarshaller.marshal(obj, writer)
	return writer.toString()
	}