simudyne.core

Interface JSONValue

All Known Subinterfaces:

AgentStatistics<T>, AgentStatisticsResult<T>, AgentSystem<S>, DoubleAccumulator, Graph<S>, LongAccumulator

All Known Implementing Classes:

GlobalState

public interface JSONValue

The JSONValue interface allows the definition of custom types within Simudyne that can be read and written to via the JSON data format.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	emitJSON(com.fasterxml.jackson.databind.node.JsonNodeFactory factory, ModelExecutionPhase phase) Defines the result of reading this datatype as JSON.
simudyne.core.schema.SchemaRecord	getRecord() Defines schema for this data type.
default com.fasterxml.jackson.databind.JsonNode	getSchema(com.fasterxml.jackson.databind.node.JsonNodeFactory factory) Defines the avro schema for the result of reading this datatype as JSON.
ValueRecord	getValues(ModelExecutionPhase phase) Defines values for this data type.
default void	receiveJSON(com.fasterxml.jackson.databind.JsonNode input, ModelExecutionPhase phase) Allows the writing of JSON to this datatype.

Method Detail

emitJSON

com.fasterxml.jackson.databind.JsonNode emitJSON(com.fasterxml.jackson.databind.node.JsonNodeFactory factory,
                                                 ModelExecutionPhase phase)

Defines the result of reading this datatype as JSON. Provides a factory for constructing a JSON value output (using the Jackson JSON library), and a phase of execution (i.e. whether the model has been setup yet or not).

Parameters:

factory - Jackson JsonNodeFactory for constructing output JSON nodes.

phase - A ModelExecutionPhase denoting the current state of execution for the model.

Returns:

A JsonNode representing the type as JSON.

getSchema

default com.fasterxml.jackson.databind.JsonNode getSchema(com.fasterxml.jackson.databind.node.JsonNodeFactory factory)

Defines the avro schema for the result of reading this datatype as JSON. Provides a JSON node to add the schema to. The JSON node provided includes the name of the JSON field, this method should add the type and fields.

Parameters:

factory - Jackson ObjectNode for constructing output JSON nodes.

Returns:

A JsonNode representing the schema as JSON.

receiveJSON

default void receiveJSON(com.fasterxml.jackson.databind.JsonNode input,
                         ModelExecutionPhase phase)

Allows the writing of JSON to this datatype. Provides the input as a parsed JsonNode input, and the phase of execution for the model.

Parameters:

input - A JsonNode representing the input as JSON.

phase - A ModelExecutionPhase denoting the current state of execution for the model.

getRecord

simudyne.core.schema.SchemaRecord getRecord()

Defines schema for this data type. This can later be converted with an appropriate class to Avro, Json etc.

getValues

ValueRecord getValues(ModelExecutionPhase phase)

Defines values for this data type. This can later be converted to different data type.