Package com.inductiveautomation.ignition.client.jsonedit

Class DocumentModel

java.lang.Object

com.inductiveautomation.ignition.client.jsonedit.DocumentModel

Direct Known Subclasses:

ComponentPropsDocumentModel

public class DocumentModel
extends java.lang.Object

Model that represents a json document, but held in memory as so to be editable by the JSON editor.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.beans.PropertyChangeSupport	change
protected DocumentNode	root
protected JsonSchema	schema
static java.lang.String	VALIDATION_RESULTS

Constructor Summary

Constructors

Constructor	Description
DocumentModel(DocumentNode root)
DocumentModel(DocumentNode root, JsonSchema schema)
DocumentModel(DocumentElement rootElement)
DocumentModel(com.inductiveautomation.ignition.common.gson.JsonElement rootElement)
DocumentModel(java.lang.String json)

Method Summary

Modifier and Type	Method	Description
void	addNodeChangeListener(NodeChangeListener listener)
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
void	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
void	addValidator(DocumentValidator validator)
void	dfs(java.util.function.Consumer<DocumentNode> visitor)	Depth first tree traversal of the document.
protected com.inductiveautomation.ignition.common.gson.JsonElement	encodeValueAsJson(DocumentNode node)
static DocumentNode	fromDocument(DocumentElement element)
static DocumentNode	fromGson(com.inductiveautomation.ignition.common.gson.JsonElement element)	Creates a DocumentNode hierarchy from a GSON json tree.
com.inductiveautomation.ignition.common.gson.JsonElement	getAsJsonTree()
DocumentNode	getRoot()
JsonSchema	getSchema()
ValidationResults	getValidationResults()
protected void	initValidators()	Override to customize JSON "validator" strategy.
boolean	isKeyEditable(DocumentNode node)
boolean	isValueEditable(DocumentNode node)
protected void	onNodeChanged(java.beans.PropertyChangeEvent event)	DocumentNodes feed ALL property change events up to the model
boolean	removeNodeChangeListener(NodeChangeListener listener)
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
com.inductiveautomation.ignition.common.gson.JsonElement	toJson(DocumentNode node)

Methods inherited from class java.lang.Object

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

Field Detail

VALIDATION_RESULTS

public static final java.lang.String VALIDATION_RESULTS

See Also:

Constant Field Values

root

protected DocumentNode root

schema

protected JsonSchema schema

change

protected final java.beans.PropertyChangeSupport change

Constructor Detail

DocumentModel

public DocumentModel(java.lang.String json)

DocumentModel

public DocumentModel(com.inductiveautomation.ignition.common.gson.JsonElement rootElement)

DocumentModel

public DocumentModel(DocumentElement rootElement)

DocumentModel

public DocumentModel(DocumentNode root)

DocumentModel

public DocumentModel(DocumentNode root,
                     @Nullable
                     JsonSchema schema)

Method Detail

getRoot

public DocumentNode getRoot()

getAsJsonTree

public com.inductiveautomation.ignition.common.gson.JsonElement getAsJsonTree()

toJson

public com.inductiveautomation.ignition.common.gson.JsonElement toJson(DocumentNode node)

encodeValueAsJson

protected com.inductiveautomation.ignition.common.gson.JsonElement encodeValueAsJson(DocumentNode node)

getSchema

@Nullable
public JsonSchema getSchema()

onNodeChanged

protected void onNodeChanged(java.beans.PropertyChangeEvent event)

DocumentNodes feed ALL property change events up to the model

isKeyEditable

public boolean isKeyEditable(DocumentNode node)

isValueEditable

public boolean isValueEditable(DocumentNode node)

addNodeChangeListener

public void addNodeChangeListener(NodeChangeListener listener)

removeNodeChangeListener

public boolean removeNodeChangeListener(NodeChangeListener listener)

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)

addValidator

public void addValidator(DocumentValidator validator)

getValidationResults

public ValidationResults getValidationResults()

dfs

public void dfs(java.util.function.Consumer<DocumentNode> visitor)

Depth first tree traversal of the document.

fromGson

public static DocumentNode fromGson(com.inductiveautomation.ignition.common.gson.JsonElement element)

Creates a DocumentNode hierarchy from a GSON json tree. All value nodes get the AUTO type.

fromDocument

public static DocumentNode fromDocument(DocumentElement element)

initValidators

protected void initValidators()

Override to customize JSON "validator" strategy. Default behavior adds a schema validator, if a schema exists, and warns about duplicate or bad quality keys.