https://github.com/workingdog/scalaeeml

an Extended Environments Markup Language (EEML) library in scala
https://github.com/workingdog/scalaeeml

Last synced: about 5 hours ago
JSON representation

an Extended Environments Markup Language (EEML) library in scala

• Host: GitHub
• URL: https://github.com/workingdog/scalaeeml
• Owner: workingDog
• License: bsd-3-clause
• Created: 2013-04-30T05:35:41.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2013-05-01T23:52:48.000Z (over 11 years ago)
• Last Synced: 2023-04-08T00:47:39.499Z (over 1 year ago)
• Language: Scala
• Size: 148 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license.txt

Awesome Lists containing this project

README

        
# scalaEeml Overview

scalaEeml is a Scala data format library of the Extended Environments Markup Language [EEML](http://www.eeml.org).

It can be used for example to interact with [COSM](https://cosm.com/) of the Internet Of Things.

From [EEML](http://www.eeml.org): "Extended Environments Markup Language (EEML)

 ...is a protocol for sharing sensor data between remote responsive environments,

 both physical and virtual. It can be used to facilitate direct connections

 between any two environments; it can also be used to facilitate many-to-many

 connections as implemented by the web service Pachube, which enables people

 to tag and share real time sensor data from objects, devices and spaces around the world."

scalaEeml is based on the XML schema for EEML 0.5.1. This library provides scala objects for the API

data format and the associated xml input/output.

The overall principle was to have a clean set of scala case classes and a separation of concerns for the IO.

# Example

    // read a xml file into a eeml root object

    val eeml = new EemlReader().getFromFile("./xml-files/test1.xml")

    // get the xml string representation and print it

    val eemlString = EemlWriter.getXmlString(eeml)

    println("eemlString = " + eemlString + "\n")

    // convert the eemlString back to a eeml root object

    val eeml2 = new EemlReader().getFromString(eemlString)

    // write the eeml2 object to a PrintWriter

    new EemlWriter(Some(new PrintWriter(System.out))).write(eeml2, new PrettyPrinter(80, 3))

# Dependencies

No dependencies.

# Notes

All member fields in the case classes are Option[_]. I find this to give more stability with only a small burden

of having to use Some(_) or Option(_). As a relief from this verbosity, I included an overridden set of constructors

that have plain arguments for all classes. The use of Option[_] is a departure from the EEML specifications.

Since I separated the IO from the classes there is no *eemlObj.toXml* to get the string xml representation

of the object. Instead use *EemlWriter.getXmlString(eemlObj)*.

Similarly use *EemlReader.getFromString(eemlString)* to get the object representation of the xml string.

# Status

scalaEeml has not been tested yet.