be.ac.umons.jsonschematools.generator.random

Class RandomGenerator

java.lang.Object

be.ac.umons.jsonschematools.generator.random.RandomGenerator

All Implemented Interfaces:

IGenerator

Direct Known Subclasses:

DefaultRandomGenerator

public class RandomGenerator
extends Object
implements IGenerator

A generator for JSON documents, given a JSON schema. 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

Constructor Summary

Constructors

Constructor and Description
RandomGenerator(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 documentDepth, boolean canGenerateInvalid) Creates an iterator over the documents this generator can produce up to the given document depth.
Iterator<org.json.JSONObject>	createIterator(JSONSchema schema, int documentDepth, boolean canGenerateInvalid, Random rand)
org.json.JSONObject	generate(JSONSchema schema, int maxTreeSize, boolean canGenerateInvalid)
org.json.JSONObject	generate(JSONSchema schema, int maxTreeSize, boolean canGenerateInvalid, Random rand)
Object	generateAccordingToConstraints(JSONSchema schema, int maxTreeSize, boolean canGenerateInvalid, Random rand) Generates a value according to the constraints given by schema.
IHandler	getArrayHandler()
IHandler	getBooleanHandler()
IHandler	getEnumHandler()
IHandler	getIntegerHandler()
IHandler	getNumberHandler()
IHandler	getObjectHandler()
IHandler	getStringHandler()

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

Constructor Detail

RandomGenerator

public RandomGenerator(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 documentDepth,
                                                    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

documentDepth - The maximal depth of the documents

canGenerateInvalid - Whether invalid documents can be generated

Returns:

An iterator

createIterator

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

generate

public org.json.JSONObject generate(JSONSchema schema,
                                    int maxTreeSize,
                                    boolean canGenerateInvalid)
                             throws JSONSchemaException,
                                    org.json.JSONException,
                                    GeneratorException

Throws:

JSONSchemaException

org.json.JSONException

GeneratorException

generate

public org.json.JSONObject generate(JSONSchema schema,
                                    int maxTreeSize,
                                    boolean canGenerateInvalid,
                                    Random rand)
                             throws JSONSchemaException,
                                    org.json.JSONException,
                                    GeneratorException

Throws:

JSONSchemaException

org.json.JSONException

GeneratorException

getStringHandler

public IHandler getStringHandler()

getIntegerHandler

public IHandler getIntegerHandler()

getNumberHandler

public IHandler getNumberHandler()

getObjectHandler

public IHandler getObjectHandler()

getArrayHandler

public IHandler getArrayHandler()

getBooleanHandler

public IHandler getBooleanHandler()

getEnumHandler

public IHandler getEnumHandler()

generateAccordingToConstraints

public Object generateAccordingToConstraints(JSONSchema schema,
                                             int maxTreeSize,
                                             boolean canGenerateInvalid,
                                             Random rand)
                                      throws org.json.JSONException,
                                             JSONSchemaException,
                                             GeneratorException

Generates a value according to the constraints given by schema.

Parameters:

schema - The JSON schema

maxTreeSize - The maximal tree depth that can be generated

rand - The random generator

Returns:

A JSON document that satisfies the schema.

Throws:

org.json.JSONException

JSONSchemaException

GeneratorException