be.ac.umons.jsonschematools.generator

Interface IGenerator

All Known Implementing Classes:

DefaultExplorationGenerator, DefaultRandomGenerator, ExplorationGenerator, RandomGenerator

public interface IGenerator

The interface for a generator producing JSON documents by using a JSONSchema.

Author:

Gaëtan Staquet

Method Summary

Modifier and Type	Method and Description
default Iterator<org.json.JSONObject>	createIterator(JSONSchema schema) Creates an iterator over the documents this generator can produce.
default Iterator<org.json.JSONObject>	createIterator(JSONSchema schema, boolean canGenerateInvalid) Creates an iterator over the documents this generator can produce.
default Iterator<org.json.JSONObject>	createIterator(JSONSchema schema, int maxDocumentDepth) 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) Creates an iterator over the documents this generator can produce up to the given document depth.

Method Detail

createIterator

default Iterator<org.json.JSONObject> createIterator(JSONSchema schema)

Creates an iterator over the documents this generator can produce. Documents are created when calling next(). The depth of the documents is not bounded, i.e., they can be an infinite number of documents if the schema is recursive. Only valid documents are generated.

Parameters:

schema - The schema

Returns:

An iterator

createIterator

default Iterator<org.json.JSONObject> createIterator(JSONSchema schema,
                                                     int maxDocumentDepth)

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. Only valid documents are generated.

Parameters:

schema - The schema

maxDocumentDepth - The maximal depth of the documents

Returns:

An iterator

createIterator

default Iterator<org.json.JSONObject> createIterator(JSONSchema schema,
                                                     boolean canGenerateInvalid)

Creates an iterator over the documents this generator can produce. Documents are created when calling next(). The depth of the documents is not bounded, i.e., they can be an infinite number of documents if the schema is recursive. Invalid documents can be generated if canGenerateInvalid is true. Note that valid documents can still be generated, no matter the value of canGenerateInvalid.

Parameters:

schema - The schema

canGenerateInvalid - Whether invalid documents can be generated

Returns:

An iterator

createIterator

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. 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.

Parameters:

schema - The schema

documentDepth - The maximal depth of the documents

canGenerateInvalid - Whether invalid documents can be generated

Returns:

An iterator