com.purplehillsbooks.json

Class JSONSchema

java.lang.Object

com.purplehillsbooks.json.JSONSchema

public class JSONSchema
extends java.lang.Object

The JSONSChema class has a static method for creating a schema object, and can be instantiated to perform schema validations.

Field Summary

Fields

Modifier and Type	Field and Description
int	errorLimit during validation, errors will be collected up to this limit, and the validation will return when the limit is reached.
boolean	recordSuccess if this is set false, then success (correct) validation is silent if set to true, then every comparison is announced

Constructor Summary

Constructors

Constructor and Description
JSONSchema()

Method Summary

Modifier and Type	Method and Description
boolean	checkSchema(JSONObject data, JSONObject schema)
static JSONObject	generateSchema(JSONObject data) Generates a schema object from the given instance.
static JSONObject	genSchemaSimpleStd(java.lang.Object o)
java.util.List<java.lang.String>	getErrorList() if the schema validation returns false, then you can ask for a detailed list of what went wrong with this method.
void	setSchemaLibrary(SchemaLibrary sLib) If the schema has a #ref token, you will need to supply a SchemaLibrary that will retrieve the reference for the schema that is named.

Methods inherited from class java.lang.Object

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

Field Detail

errorLimit

public int errorLimit

during validation, errors will be collected up to this limit, and the validation will return when the limit is reached. If you just want to find the first error, set the limit to 1.

recordSuccess

public boolean recordSuccess

if this is set false, then success (correct) validation is silent if set to true, then every comparison is announced

Constructor Detail

JSONSchema

public JSONSchema()

Method Detail

setSchemaLibrary

public void setSchemaLibrary(SchemaLibrary sLib)

If the schema has a #ref token, you will need to supply a SchemaLibrary that will retrieve the reference for the schema that is named. Any attempt to validate a schema which inludes a #ref will fail if there is no schema library to supply the references schema.

generateSchema

public static JSONObject generateSchema(JSONObject data)
                                 throws java.lang.Exception

Generates a schema object from the given instance. This is a default schema which will probably have to be edited to take into consideration variances. OF course, it will only include data members that exist. It assumes that all members are required. It uses the type of value found in the first instance of a member to set the type of that members. If there is an array, it walks through the array and finds the union of all the members on the objects. If you want to allow additional members you need to create your own additionalProperties entry. If you want to allow members to have varying types, you will need to remove the type indicator.

Throws:

java.lang.Exception

genSchemaSimpleStd

public static JSONObject genSchemaSimpleStd(java.lang.Object o)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

checkSchema

public boolean checkSchema(JSONObject data,
                           JSONObject schema)
                    throws java.lang.Exception

Throws:

java.lang.Exception

getErrorList

public java.util.List<java.lang.String> getErrorList()

if the schema validation returns false, then you can ask for a detailed list of what went wrong with this method. Each string in the list is a separate validation error. You will only get up to the number of errors specified in the errorLimit variable.