jsondiscoverer

Class JsonSource

java.lang.Object

jsondiscoverer.AbstractJsonSource

jsondiscoverer.JsonSource

Direct Known Subclasses:

SingleJsonSource

public class JsonSource
extends AbstractJsonSource

This class represents a JSON source. A JSON source is represented by a set of JSON documents with the same meaning (i.e., set of JSON documents returned by the same JSON-based Web API).

In the context of JSON Discoverer, it is used to model a single JSON-based Web service.

JSON documents are represented as JsonData elements.

The set of JSON documents can be retrieved by calling the method getJsonData().

As JsonData elements can include input elements (to represent which JSON data has triggered such JSON document), a JsonSource can include JsonData elements with or without input. To know whether the JsonData elements included in the JsonSource have input elements, you have to call the method withInput.

Note that all the JsonData elements included in a JsonSource have to include (or not include) inputs.

Author:

Javier Canovas (me@jlcanovas.es)

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<JsonData>	jsonData List of JSON documents
boolean	withInput Sets if the set of JSON documents are the result of computing an input JSON document (to support JSON-based Web APIs)

Constructor Summary

Constructors

Constructor and Description
JsonSource(java.lang.String name) Builds a new JsonSource with a name.

Method Summary

Modifier and Type	Method and Description
void	addJsonData(java.io.Reader input, java.io.Reader output) Adds a new JSON document as well as the input JSON document (optional) to get such a document.
private JsonData	buildJsonData(java.io.Reader input, java.io.Reader output) Builds a JsonData element out of a JSON document representing the input and another JSON document representing the output.
protected java.util.List<JsonData>	getJsonData() Gets the set of JsonData elements linked to this source.
java.util.List<com.google.gson.JsonObject>	getSourceDigested() Generates a list of JSON objects according to the JsonData of this source.
boolean	includesInput() Indicates if the JsonSource includes input elements.

Methods inherited from class jsondiscoverer.AbstractJsonSource

getMetamodel, getName, setMetamodel, setName

Methods inherited from class java.lang.Object

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

Field Detail

jsonData

protected java.util.List<JsonData> jsonData

List of JSON documents

withInput

public boolean withInput

Sets if the set of JSON documents are the result of computing an input JSON document (to support JSON-based Web APIs)

Constructor Detail

JsonSource

public JsonSource(java.lang.String name)

Builds a new JsonSource with a name. Once created, the JsonSource has to be populated by calling addJsonData(Reader, Reader).

Parameters:

name - The name of the JsonSource

Method Detail

getJsonData

protected java.util.List<JsonData> getJsonData()

Gets the set of JsonData elements linked to this source. Warning: the returned list is mutable

Returns:

The set of JSON documents (as JsonData

includesInput

public boolean includesInput()

Indicates if the JsonSource includes input elements.

Note that all of them have to include (or not include) input elements

Returns:

Boolean indicating the status

buildJsonData

private JsonData buildJsonData(java.io.Reader input,
                               java.io.Reader output)

Builds a JsonData element out of a JSON document representing the input and another JSON document representing the output.

The input/output must be provided as a valid JSON objects.

Parameters:

input - The Reader from which obtain JSON document used as input (optional)

output - The Reader from which obtain the JSON document

Returns:

The JsonData with the JSON document and the input

Throws:

java.lang.IllegalArgumentException - If any reader is null

addJsonData

public void addJsonData(java.io.Reader input,
                        java.io.Reader output)

Adds a new JSON document as well as the input JSON document (optional) to get such a document.

The input/output must be provided as a valid JSON objects.

Warning: Once the source has been created with input (or without), subsequent calls must also include (or not) inputs

Parameters:

input - The Reader from which obtain the JSON document used as input (optional)

output - The Reader from which obtain the JSON document

Throws:

java.lang.IllegalArgumentException - If input is null

java.lang.IllegalStateException - If the JSON source was initially created to not hold input data

getSourceDigested

public java.util.List<com.google.gson.JsonObject> getSourceDigested()

Generates a list of JSON objects according to the JsonData of this source.

• If the source DOES include inputs, the list will include the set of input elements as roots for the JsonData. For instance:

 - [input JSON element 1]
   +-- Output
       +-- [output JSON element 1]  
 - [input JSON element 2]
   +-- Output
       +-- [output JSON element 2]  
 -...
 

• If the source DOES NOT include inputs, the list will include all the objects from JsonData. For instance

 - [output JSON element 1]  
 - [output JSON element 2] 
 - [output JSON element 3] 
 -...
 

Returns:

The list of JsonObjects