Package com.inductiveautomation.ignition.common.jsonschema

Class BaseJsonValidator

java.lang.Object

com.inductiveautomation.ignition.common.jsonschema.BaseJsonValidator

All Implemented Interfaces:

JsonValidator

Direct Known Subclasses:

AdditionalPropertiesValidator, AllOfValidator, AnyOfValidator, ConstValidator, ContainsValidator, DependenciesValidator, DynamicSuggestionsValidator, EnumValidator, ExtensionValidator, FormatValidator, ItemsValidator, JsonSchema, MaximumValidator, MaxItemsValidator, MaxLengthValidator, MaxPropertiesValidator, MinimumValidator, MinItemsValidator, MinLengthValidator, MinPropertiesValidator, MultipleOfValidator, NotValidator, OneOfValidator, PatternPropertiesValidator, PatternValidator, PropertiesValidator, PropertyNamesValidator, RefValidator, RequiredValidator, SuggestionsValidator, TypeValidator, UniqueItemsValidator, VisibleWhenValidator

public abstract class BaseJsonValidator
extends java.lang.Object
implements JsonValidator

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.common.jsonschema.JsonValidator

AT_ROOT

Constructor Summary

Constructors

Constructor	Description
BaseJsonValidator(java.lang.String schemaPath, com.inductiveautomation.ignition.common.gson.JsonElement schemaNode, JsonSchema parentSchema, ValidatorTypeCode validatorType)
BaseJsonValidator(java.lang.String schemaPath, com.inductiveautomation.ignition.common.gson.JsonElement schemaNode, JsonSchema parentSchema, ValidatorTypeCode validatorType, boolean useRefCache)
BaseJsonValidator(java.lang.String schemaPath, com.inductiveautomation.ignition.common.gson.JsonElement schemaNode, JsonSchema parentSchema, ValidatorTypeCode validatorType, JsonSchema subSchema)
BaseJsonValidator(java.lang.String schemaPath, com.inductiveautomation.ignition.common.gson.JsonElement schemaNode, JsonSchema parentSchema, ValidatorTypeCode validatorType, JsonSchema subSchema, boolean useRefCache)

Method Summary

Modifier and Type	Method	Description
int	asInt(com.inductiveautomation.ignition.common.gson.JsonElement element)
protected ValidationMessage	buildValidationMessage(java.lang.String at, java.lang.String... arguments)
protected void	debug(org.slf4j.Logger logger, com.inductiveautomation.ignition.common.gson.JsonElement node, com.inductiveautomation.ignition.common.gson.JsonElement rootNode, java.lang.String at)
protected boolean	equals(double n1, double n2)
protected JsonSchema	getParentSchema()
protected com.inductiveautomation.ignition.common.gson.JsonElement	getSchemaNode()
protected java.lang.String	getSchemaPath()
protected JsonSchema	getSubSchema()
protected ValidatorTypeCode	getValidatorType()
protected boolean	greaterThan(double n1, double n2)
protected boolean	hasSubSchema()
protected boolean	lessThan(double n1, double n2)
protected JsonSchema	obtainSubSchemaNode(com.inductiveautomation.ignition.common.gson.JsonElement schemaNode)
protected void	parseErrorCode(java.lang.String errorCodeKey)
protected boolean	useRefCache()
java.util.Set<ValidationMessage>	validate(com.inductiveautomation.ignition.common.gson.JsonElement node)	Validate the given root JsonElement, starting at the root of the data path.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.common.jsonschema.JsonValidator

validate

Constructor Detail

BaseJsonValidator

public BaseJsonValidator(java.lang.String schemaPath,
                         com.inductiveautomation.ignition.common.gson.JsonElement schemaNode,
                         JsonSchema parentSchema,
                         ValidatorTypeCode validatorType)

BaseJsonValidator

public BaseJsonValidator(java.lang.String schemaPath,
                         com.inductiveautomation.ignition.common.gson.JsonElement schemaNode,
                         JsonSchema parentSchema,
                         ValidatorTypeCode validatorType,
                         JsonSchema subSchema,
                         boolean useRefCache)

BaseJsonValidator

public BaseJsonValidator(java.lang.String schemaPath,
                         com.inductiveautomation.ignition.common.gson.JsonElement schemaNode,
                         JsonSchema parentSchema,
                         ValidatorTypeCode validatorType,
                         JsonSchema subSchema)

BaseJsonValidator

public BaseJsonValidator(java.lang.String schemaPath,
                         com.inductiveautomation.ignition.common.gson.JsonElement schemaNode,
                         JsonSchema parentSchema,
                         ValidatorTypeCode validatorType,
                         boolean useRefCache)

Method Detail

getSchemaPath

protected java.lang.String getSchemaPath()

getSchemaNode

protected com.inductiveautomation.ignition.common.gson.JsonElement getSchemaNode()

getParentSchema

protected JsonSchema getParentSchema()

getSubSchema

protected JsonSchema getSubSchema()

hasSubSchema

protected boolean hasSubSchema()

useRefCache

protected boolean useRefCache()

obtainSubSchemaNode

protected JsonSchema obtainSubSchemaNode(com.inductiveautomation.ignition.common.gson.JsonElement schemaNode)

validate

public java.util.Set<ValidationMessage> validate(com.inductiveautomation.ignition.common.gson.JsonElement node)

Description copied from interface: JsonValidator

Validate the given root JsonElement, starting at the root of the data path.

Specified by:

validate in interface JsonValidator

Parameters:

node - JsonElement

Returns:

A list of ValidationMessage if there is any validation error, or an empty list if there is no error.

equals

protected boolean equals(double n1,
                         double n2)

greaterThan

protected boolean greaterThan(double n1,
                              double n2)

lessThan

protected boolean lessThan(double n1,
                           double n2)

parseErrorCode

protected void parseErrorCode(java.lang.String errorCodeKey)

buildValidationMessage

protected ValidationMessage buildValidationMessage(java.lang.String at,
                                                   java.lang.String... arguments)

debug

protected void debug(org.slf4j.Logger logger,
                     com.inductiveautomation.ignition.common.gson.JsonElement node,
                     com.inductiveautomation.ignition.common.gson.JsonElement rootNode,
                     java.lang.String at)

getValidatorType

protected ValidatorTypeCode getValidatorType()

asInt

public int asInt(com.inductiveautomation.ignition.common.gson.JsonElement element)