Package com.inductiveautomation.ignition.common.jsonschema

Class VisibleWhenValidator

java.lang.Object

com.inductiveautomation.ignition.common.jsonschema.BaseJsonValidator

com.inductiveautomation.ignition.common.jsonschema.VisibleWhenValidator

All Implemented Interfaces:

JsonValidator

public class VisibleWhenValidator
extends BaseJsonValidator
implements JsonValidator

This validator, which is a proprietary json-schema extension that we added for Ignition, supplies a condition to control when a given property should be visible by specifying a sibling property and value(s) for which this property is considered relevant.

Field Summary

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

AT_ROOT

Constructor Summary

Constructors

Constructor	Description
VisibleWhenValidator(java.lang.String schemaPath, com.inductiveautomation.ignition.common.gson.JsonElement schemaNode, JsonSchema parentSchema)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDrivingProperty()
java.util.List<com.inductiveautomation.ignition.common.gson.JsonElement>	getEqualsValues()
java.util.Set<ValidationMessage>	validate(com.inductiveautomation.ignition.common.gson.JsonElement node, com.inductiveautomation.ignition.common.gson.JsonElement rootNode, java.lang.String at)	Validate the given JsonElement, the given node is the child node of the root node at given data path.

Methods inherited from class com.inductiveautomation.ignition.common.jsonschema.BaseJsonValidator

asInt, buildValidationMessage, debug, equals, getParentSchema, getSchemaNode, getSchemaPath, getSubSchema, getValidatorType, greaterThan, hasSubSchema, lessThan, obtainSubSchemaNode, parseErrorCode, useRefCache, validate

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

VisibleWhenValidator

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

Method Detail

getDrivingProperty

public java.lang.String getDrivingProperty()

getEqualsValues

public java.util.List<com.inductiveautomation.ignition.common.gson.JsonElement> getEqualsValues()

validate

public java.util.Set<ValidationMessage> validate(com.inductiveautomation.ignition.common.gson.JsonElement node,
                                                 com.inductiveautomation.ignition.common.gson.JsonElement rootNode,
                                                 java.lang.String at)

Description copied from interface: JsonValidator

Validate the given JsonElement, the given node is the child node of the root node at given data path.

Specified by:

validate in interface JsonValidator

Parameters:

node - JsonElement

rootNode - JsonElement

at - String

Returns:

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