Package de.iip_ecosphere.platform.connectors.formatter

Class JsonOutputFormatter

java.lang.Object

de.iip_ecosphere.platform.connectors.formatter.JsonOutputFormatter

All Implemented Interfaces:

OutputFormatter<de.iip_ecosphere.platform.support.function.IOConsumer<de.iip_ecosphere.platform.support.json.JsonGenerator>>

@MachineFormatter
public class JsonOutputFormatter
extends Object
implements OutputFormatter<de.iip_ecosphere.platform.support.function.IOConsumer<de.iip_ecosphere.platform.support.json.JsonGenerator>>

JSON output formatter (preliminary).

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonOutputFormatter.JsonOutputConverter
private static enum	JsonOutputFormatter.StructureType

Nested classes/interfaces inherited from interface de.iip_ecosphere.platform.connectors.formatter.OutputFormatter

OutputFormatter.OutputConverter<T>

Field Summary

Fields

Modifier and Type	Field	Description
private de.iip_ecosphere.platform.support.json.JsonGenerator	gen
private String	parentName
private Stack<JsonOutputFormatter.StructureType>	structures
private StringWriter	writer

Fields inherited from interface de.iip_ecosphere.platform.connectors.formatter.OutputFormatter

SEPARATOR

Constructor Summary

Constructors

Constructor	Description
JsonOutputFormatter()

Method Summary

Modifier and Type	Method	Description
void	add(String name, de.iip_ecosphere.platform.support.function.IOConsumer<de.iip_ecosphere.platform.support.json.JsonGenerator> func)	Adds information to one chunk of output.
byte[]	chunkCompleted()	Completes a chunk of output data.
private void	cleanNesting(String parent)	Cleans up the nesting.
void	endStructure()	Ends a structure started before.
JsonOutputFormatter.JsonOutputConverter	getConverter()	Returns the output converter.
private void	initialize()	Initializes the JSON writing.
void	startArrayStructure(String name)	Starts an array structure.
void	startObjectStructure(String name)	Starts an object structure.

Methods inherited from class java.lang.Object

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

Field Details

writer

private StringWriter writer

gen

private de.iip_ecosphere.platform.support.json.JsonGenerator gen

parentName

private String parentName

structures

private Stack<JsonOutputFormatter.StructureType> structures

Constructor Details

JsonOutputFormatter

public JsonOutputFormatter()

Method Details

cleanNesting

private void cleanNesting(String parent)
                   throws IOException

Cleans up the nesting.

Parameters:

parent - the target parent path

Throws:

IOException - when writing data fails

initialize

private void initialize()
                 throws IOException

Initializes the JSON writing.

Throws:

IOException - if initialization fails

add

public void add(String name,
 de.iip_ecosphere.platform.support.function.IOConsumer<de.iip_ecosphere.platform.support.json.JsonGenerator> func)
         throws IOException

Description copied from interface: OutputFormatter

Adds information to one chunk of output. Hierarchical names separated by OutputFormatter.SEPARATOR can be used, but nested values for the same parent (object) field must be named in sequence.

Specified by:

add in interface OutputFormatter<de.iip_ecosphere.platform.support.function.IOConsumer<de.iip_ecosphere.platform.support.json.JsonGenerator>>

Parameters:

name - optional data name field (may be null for none)

func - the data to be added

Throws:

IOException - if adding the data fails for some reason

startArrayStructure

public void startArrayStructure(String name)
                         throws IOException

Description copied from interface: OutputFormatter

Starts an array structure. Following OutputFormatter.add(String, Object) calls will add elements to the array. Must be closed with OutputFormatter.endStructure()

Specified by:

startArrayStructure in interface OutputFormatter<de.iip_ecosphere.platform.support.function.IOConsumer<de.iip_ecosphere.platform.support.json.JsonGenerator>>

Parameters:

name - optional data name field holding the array (may be null for none)

Throws:

IOException - if starting this structure fails

startObjectStructure

public void startObjectStructure(String name)
                          throws IOException

Description copied from interface: OutputFormatter

Starts an object structure. Following OutputFormatter.add(String, Object) calls will add elements to the object. Must be closed with OutputFormatter.endStructure()

Specified by:

startObjectStructure in interface OutputFormatter<de.iip_ecosphere.platform.support.function.IOConsumer<de.iip_ecosphere.platform.support.json.JsonGenerator>>

Parameters:

name - optional data name field holding the array (may be null for none)

Throws:

IOException - if starting this structure fails

endStructure

public void endStructure()
                  throws IOException

Description copied from interface: OutputFormatter

Ends a structure started before.

Specified by:

endStructure in interface OutputFormatter<de.iip_ecosphere.platform.support.function.IOConsumer<de.iip_ecosphere.platform.support.json.JsonGenerator>>

Throws:

IOException - if ending the actual structure fails

chunkCompleted

public byte[] chunkCompleted()
                      throws IOException

Description copied from interface: OutputFormatter

Completes a chunk of output data.

Specified by:

chunkCompleted in interface OutputFormatter<de.iip_ecosphere.platform.support.function.IOConsumer<de.iip_ecosphere.platform.support.json.JsonGenerator>>

Returns:

the chunk

Throws:

IOException - if creating the chunk fails for some reason

getConverter

public JsonOutputFormatter.JsonOutputConverter getConverter()

Description copied from interface: OutputFormatter

Returns the output converter.

Specified by:

getConverter in interface OutputFormatter<de.iip_ecosphere.platform.support.function.IOConsumer<de.iip_ecosphere.platform.support.json.JsonGenerator>>

Returns:

the output converter