be.ac.umons.jsonschematools.generator.exploration

Class ExplorationGenerator

java.lang.Object

be.ac.umons.jsonschematools.generator.exploration.ExplorationGenerator

All Implemented Interfaces:

IGenerator

Direct Known Subclasses:

DefaultExplorationGenerator

public class ExplorationGenerator
extends Object
implements IGenerator

A generator that produces documents by exhaustively exploring the possibilities described in a JSON schema. If the schema contains a recursive part, an infinite number of documents can be generated. This implementation relies on external classes to handle each type allowed in a JSON schema. See the handlers package for implemented handlers.

Author:

Gaëtan Staquet

Field Summary

Fields

Modifier and Type	Field and Description
static Optional<Object>	EMPTY_VALUE_DUE_TO_MAX_DEPTH

Constructor Summary

Constructors

Constructor and Description
ExplorationGenerator(IHandler stringHandler, IHandler integerHandler, IHandler numberHandler, IHandler booleanHandler, IHandler enumHandler, IHandler objectHandler, IHandler arrayHandler)

Method Summary

Modifier and Type	Method and Description
Iterator<org.json.JSONObject>	createIterator(JSONSchema schema, int maxDocumentDepth, boolean canGenerateInvalid) Creates an iterator over the documents this generator can produce up to the given document depth.
org.json.JSONObject	generateDocument(JSONSchema schema, int maxDocumentDepth, boolean canGenerateInvalid, ChoicesSequence choices)
Optional<Object>	generateValueAccordingToConstraints(JSONSchema schema, int maxDocumentDepth, boolean canGenerateInvalid, ChoicesSequence choices) Generates a value according to the constraints given in the schema and following the sequence of choices.
Optional<Object>	generateValueAccordingToConstraints(JSONSchema schema, int maxDocumentDepth, boolean canGenerateInvalid, ChoicesSequence choices, boolean mustBeObject)

Methods inherited from class java.lang.Object

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

Methods inherited from interface be.ac.umons.jsonschematools.generator.IGenerator

createIterator, createIterator, createIterator

Field Detail

EMPTY_VALUE_DUE_TO_MAX_DEPTH

public static final Optional<Object> EMPTY_VALUE_DUE_TO_MAX_DEPTH

Constructor Detail

ExplorationGenerator

public ExplorationGenerator(IHandler stringHandler,
                            IHandler integerHandler,
                            IHandler numberHandler,
                            IHandler booleanHandler,
                            IHandler enumHandler,
                            IHandler objectHandler,
                            IHandler arrayHandler)

Method Detail

createIterator

public Iterator<org.json.JSONObject> createIterator(JSONSchema schema,
                                                    int maxDocumentDepth,
                                                    boolean canGenerateInvalid)

Description copied from interface: IGenerator

Creates an iterator over the documents this generator can produce up to the given document depth. Documents are created when calling next(). The depth of the documents is bounded, i.e., in any document, there can only be at most maxDocumentDepth nested objects and arrays. Note that if the bound is set too low, only invalid documents may be generated as the deepest objects or arrays may not be correct. In particular, no documents will be generated with a depth of zero. Invalid documents can be generated if canGenerateInvalid is true. Note that valid documents can still be generated, no matter the value of canGenerateInvalid.

Specified by:

createIterator in interface IGenerator

Parameters:

schema - The schema

maxDocumentDepth - The maximal depth of the documents

canGenerateInvalid - Whether invalid documents can be generated

Returns:

An iterator

generateDocument

public org.json.JSONObject generateDocument(JSONSchema schema,
                                            int maxDocumentDepth,
                                            boolean canGenerateInvalid,
                                            ChoicesSequence choices)
                                     throws org.json.JSONException,
                                            JSONSchemaException

Throws:

org.json.JSONException

JSONSchemaException

generateValueAccordingToConstraints

public Optional<Object> generateValueAccordingToConstraints(JSONSchema schema,
                                                            int maxDocumentDepth,
                                                            boolean canGenerateInvalid,
                                                            ChoicesSequence choices)
                                                     throws org.json.JSONException,
                                                            JSONSchemaException

Generates a value according to the constraints given in the schema and following the sequence of choices.

Parameters:

schema - The schema

maxDocumentDepth - The maximal depth of the document

choices - The sequence of choices

Returns:

An optional containing the value, if it was possible to generate it.

Throws:

org.json.JSONException

JSONSchemaException

generateValueAccordingToConstraints

public Optional<Object> generateValueAccordingToConstraints(JSONSchema schema,
                                                            int maxDocumentDepth,
                                                            boolean canGenerateInvalid,
                                                            ChoicesSequence choices,
                                                            boolean mustBeObject)
                                                     throws org.json.JSONException,
                                                            JSONSchemaException

Throws:

org.json.JSONException

JSONSchemaException