com.github.fge.jsonschema.tree

Class BaseSchemaTree

java.lang.Object

com.github.fge.jsonschema.tree.BaseSchemaTree

All Implemented Interfaces:

SchemaTree, SimpleTree, AsJson

Direct Known Subclasses:

CanonicalSchemaTree, InlineSchemaTree

public abstract class BaseSchemaTree
extends Object
implements SchemaTree

A JsonTree carrying URI resolution context information

In addition to what JsonTree does, this tree also modifies URI resolution context information when changing paths, and adds methods in order to query this resolution context.

All context information is carried as JSON References, since this is what is used for addressing in JSON Schema.

See Also:

JsonRef, CanonicalSchemaTree, InlineSchemaTree

Field Summary

Fields

Modifier and Type	Field and Description
protected JsonNode	baseNode The initial node
protected JsonRef	currentRef The current resolution context
protected JsonRef	loadingRef The JSON Reference from which this node has been loaded
protected JsonNode	node The current node.
protected JsonPointer	pointer The current JSON Pointer into the node.
protected JsonRef	startingRef The JSON Reference representing the context at the root of the schema
protected boolean	valid Whether this schema is valid

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseSchemaTree(JsonRef loadingRef, JsonNode baseNode, Dereferencing dereferencing) The main constructor
protected	BaseSchemaTree(JsonRef loadingRef, JsonNode baseNode, JsonPointer pointer, Dereferencing dereferencing, boolean valid)

Method Summary

Methods

Modifier and Type	Method and Description
JsonNode	asJson()
JsonNode	getBaseNode() Return the node this tree was created with
JsonRef	getContext() Get the current resolution context
JsonRef	getLoadingRef() Get the loading URI for that schema
JsonNode	getNode() Get the node at the current path
JsonPointer	getPointer() Get the current path into the document
protected static JsonRef	idFromNode(JsonNode node) Build a JSON Reference from a node
boolean	isValid() Tell whether this schema has been deemed valid by the syntax processor
JsonRef	resolve(JsonRef other) Resolve a JSON Reference against the current resolution context
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.fge.jsonschema.tree.SchemaTree

append, containsRef, matchingPointer, setPointer, withValidationStatus

Field Detail

valid

protected final boolean valid

Whether this schema is valid

baseNode

protected final JsonNode baseNode

The initial node

pointer

protected final JsonPointer pointer

The current JSON Pointer into the node. Starts empty.

node

protected final JsonNode node

The current node.

loadingRef

protected final JsonRef loadingRef

The JSON Reference from which this node has been loaded

If loaded without a URI, this will be the empty reference.

startingRef

protected final JsonRef startingRef

The JSON Reference representing the context at the root of the schema

It will defer from loadingRef if there is an id at the top level.

currentRef

protected final JsonRef currentRef

The current resolution context

Constructor Detail

BaseSchemaTree

protected BaseSchemaTree(JsonRef loadingRef,
              JsonNode baseNode,
              Dereferencing dereferencing)

The main constructor

Parameters:

loadingRef - the loading reference

baseNode - the base node

BaseSchemaTree

protected BaseSchemaTree(JsonRef loadingRef,
              JsonNode baseNode,
              JsonPointer pointer,
              Dereferencing dereferencing,
              boolean valid)

Method Detail

getBaseNode

public final JsonNode getBaseNode()

Description copied from interface: SimpleTree

Return the node this tree was created with

Note: in current Jackson versions, this node is unfortunately mutable, so be careful...

Specified by:

getBaseNode in interface SimpleTree

Returns:

the node

getPointer

public final JsonPointer getPointer()

Description copied from interface: SimpleTree

Get the current path into the document

Specified by:

getPointer in interface SimpleTree

Returns:

the path as a JSON Pointer

getNode

public final JsonNode getNode()

Description copied from interface: SimpleTree

Get the node at the current path

Specified by:

getNode in interface SimpleTree

Returns:

the matching node (a MissingNode if there is no matching node at that pointer)

resolve

public final JsonRef resolve(JsonRef other)

Resolve a JSON Reference against the current resolution context

Specified by:

resolve in interface SchemaTree

Parameters:

other - the JSON Reference to resolve

Returns:

the resolved reference

See Also:

JsonRef.resolve(JsonRef)

getLoadingRef

public final JsonRef getLoadingRef()

Get the loading URI for that schema

Specified by:

getLoadingRef in interface SchemaTree

Returns:

the loading URI as a JsonRef

getContext

public final JsonRef getContext()

Get the current resolution context

Specified by:

getContext in interface SchemaTree

Returns:

the context as a JsonRef

isValid

public final boolean isValid()

Description copied from interface: SchemaTree

Tell whether this schema has been deemed valid by the syntax processor

Specified by:

isValid in interface SchemaTree

Returns:

true if the schema is valid

idFromNode

protected static JsonRef idFromNode(JsonNode node)

Build a JSON Reference from a node

This will return null if the reference could not be built. The conditions for a successful build are as follows:

• the node is an object;
• it has a member named id;
• the value of this member is a string;
• this string is a valid URI.

Parameters:

node - the node

Returns:

a JSON Reference, or null

asJson

public final JsonNode asJson()

Specified by:

asJson in interface AsJson

toString

public final String toString()

Overrides:

toString in class Object