jsondiscoverer.zoo

Class ZooDiscoverer

java.lang.Object

jsondiscoverer.zoo.ZooDiscoverer

public class ZooDiscoverer
extends java.lang.Object

This class traverses a given path to discover the metamodels for JSON files.

The path has to conform to a particular structure. Thus, the root path has to be composed by a set of folder (one per API), where each folder contains subfolders (one per JSON source).

For each JSON source, it is expected to find a "info.properties" file which the "name" and "shortname" properties describing the source. Furthermore, a set of JSON files have to be included in the JSON source. Each JSON file name must start with "json" string and it is expected both a .json * and a .properties file (with the same name), including the json text and the property "call" to invoke the service.

This is and example of such an organization:

 - RootPath
   +-- API1
       +-- source1
           +-- info.properties
           +-- json1.json
           +-- json1.properties
           +-- json2.json
           +-- json2.properties
           +-- ...
       +-- sourcen
           +-- ...     
   +-- API2
       +-- ...
   +-- APIn
       +-- ...
 

We recommend you to have a look at the existing examples on this project to better understand how to configure the folder and the files.

Author:

Javier Canovas (me@jlcanovas.es)

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.logging.Logger	LOGGER The logger to keep track of all the execution traces
private java.io.File	rootPath The root from where the process will start

Constructor Summary

Constructors

Constructor and Description
ZooDiscoverer(java.io.File rootPath) Constructs a new ZooDiscoverer element.

Method Summary

Modifier and Type	Method and Description
void	discover() Launches the discovery process.
void	discover(boolean overwrite) Main method to start the discovery process.
private JsonSource	discoverSource(java.io.File rootPath, boolean overwrite) Performs the discovery for a specific directory.
private org.eclipse.emf.ecore.EPackage	loadEcore(java.io.File target) Loads a metamodel (as EPackage)
private void	saveEcore(org.eclipse.emf.ecore.EPackage metamodel, java.io.File target) Saves a metamodel (as EPackage) into a file
private static void	saveModel(java.util.List<org.eclipse.emf.ecore.EObject> elements, java.io.File target) Save a list of model elements (as EObjects) into a file

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER

private static final java.util.logging.Logger LOGGER

The logger to keep track of all the execution traces

rootPath

private java.io.File rootPath

The root from where the process will start

Constructor Detail

ZooDiscoverer

public ZooDiscoverer(java.io.File rootPath)

Constructs a new ZooDiscoverer element. Requires the starting directory path

Parameters:

rootPath - The path from where the process will start

Method Detail

discover

public void discover()
              throws java.io.FileNotFoundException

Launches the discovery process.

This method relies on discoverSource(File, boolean) with the second parameter (overwriting) active.

Throws:

java.io.FileNotFoundException - Something went wrong when looking for a file

discover

public void discover(boolean overwrite)
              throws java.io.FileNotFoundException

Main method to start the discovery process. The result can overwrites (or not) accodirng to the param.

Basically traverses the rootPath folder and calls to discoverSource(File, boolean) to discover a JsonSource element for each source (see class desc

Parameters:

overwrite - The result has to overwrite (or not) previous executions

Throws:

java.io.FileNotFoundException - Something went wrong when looking for a file

discoverSource

private JsonSource discoverSource(java.io.File rootPath,
                                  boolean overwrite)
                           throws java.io.FileNotFoundException,
                                  java.io.IOException

Performs the discovery for a specific directory.

The folder has to follow this pattern (example with two JSON sources):

   +-- source1
      +-- info.properties
      +-- json1.json
      +-- json1.properties
      +-- json2.json
      +-- json2.properties
  

The discovery process follow these steps:

1. First the info.properties is checked
2. For each JSON source (composed by a .json and a .properties file): The properties files is read (e.g., json1.properties) and the JSON file is read (e.g., json1.json)

As a result, a JsonSource is built, which includes all the JSON sources plus the discovered metamodel (as a EPackage)

Parameters:

rootPath - The folder to analyze

overwrite - If the results have to overwrite previous ones

Returns:

A JsonSource with the JSON sources provided and the metamodel

Throws:

java.io.FileNotFoundException - A file required in the folder (check the doc to see the expected structure) was not found

java.io.IOException - Thrown when having problem while reading/writing files

saveEcore

private void saveEcore(org.eclipse.emf.ecore.EPackage metamodel,
                       java.io.File target)

Saves a metamodel (as EPackage) into a file

Parameters:

metamodel - The metamodel

target - The file where the metamodel will be stored

loadEcore

private org.eclipse.emf.ecore.EPackage loadEcore(java.io.File target)

Loads a metamodel (as EPackage)

Parameters:

target - The path to the metamodel

Returns:

The metamodel (as EPackage)

saveModel

private static void saveModel(java.util.List<org.eclipse.emf.ecore.EObject> elements,
                              java.io.File target)

Save a list of model elements (as EObjects) into a file

Parameters:

elements - List of model elements (as EObjects)

target - The path for the file