Module org.phenopackets.phenopackettools.validator.jsonschema

Package org.phenopackets.phenopackettools.validator.jsonschema

Class JsonSchemaValidationWorkflowRunnerBuilder<T extends com.google.protobuf.MessageOrBuilder>

java.lang.Object

org.phenopackets.phenopackettools.validator.core.ValidationWorkflowRunnerBuilder<T>

org.phenopackets.phenopackettools.validator.jsonschema.JsonSchemaValidationWorkflowRunnerBuilder<T>

Type Parameters:

T - one of top-level elements of the Phenopacket schema.

public abstract class JsonSchemaValidationWorkflowRunnerBuilder<T extends com.google.protobuf.MessageOrBuilder>
extends ValidationWorkflowRunnerBuilder<T>

A builder for JsonSchemaValidationWorkflowRunner.

Build the JsonSchemaValidationWorkflowRunner by providing JSON schema documents either as Path or URLs, and PhenopacketValidators for performing semantic validation.

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<URL>	jsonSchemaUrls

Fields inherited from class org.phenopackets.phenopackettools.validator.core.ValidationWorkflowRunnerBuilder

semanticValidators, syntaxValidators

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JsonSchemaValidationWorkflowRunnerBuilder()

Method Summary

Modifier and Type	Method	Description
JsonSchemaValidationWorkflowRunnerBuilder<T>	addAllJsonSchemaPaths(Iterable<Path> paths)	Add JSON schemas in bulk.
JsonSchemaValidationWorkflowRunnerBuilder<T>	addAllJsonSchemaUrls(List<URL> urls)	Add JSON schemas in bulk.
JsonSchemaValidationWorkflowRunnerBuilder<T>	addJsonSchema(URL url)	Register a JSON schema present at a given url to be used as a syntax validator.
JsonSchemaValidationWorkflowRunnerBuilder<T>	addJsonSchema(Path path)	Register a JSON schema present at a given path to be used as a syntax validator.
abstract JsonSchemaValidationWorkflowRunner<T>	build()	Finish building the JsonSchemaValidationWorkflowRunner.

Methods inherited from class org.phenopackets.phenopackettools.validator.core.ValidationWorkflowRunnerBuilder

addAllSemanticValidators, addAllSyntaxValidators, addSemanticValidator, addSyntaxValidator

Methods inherited from class java.lang.Object

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

Field Details

jsonSchemaUrls

protected final List<URL> jsonSchemaUrls

Constructor Details

JsonSchemaValidationWorkflowRunnerBuilder

protected JsonSchemaValidationWorkflowRunnerBuilder()

Method Details

addJsonSchema

public JsonSchemaValidationWorkflowRunnerBuilder<T> addJsonSchema(Path path)
                                                           throws MalformedURLException

Register a JSON schema present at a given path to be used as a syntax validator. The path will be interpreted as a URL.

Parameters:

path - path to the JSON schema document

Returns:

the builder

Throws:

MalformedURLException - if the path cannot be converted to a well-formatted URL

addJsonSchema

public JsonSchemaValidationWorkflowRunnerBuilder<T> addJsonSchema(URL url)

Register a JSON schema present at a given url to be used as a syntax validator.

Parameters:

url - url to the JSON schema document

Returns:

the builder

addAllJsonSchemaPaths

public JsonSchemaValidationWorkflowRunnerBuilder<T> addAllJsonSchemaPaths(Iterable<Path> paths)
                                                                   throws MalformedURLException

Add JSON schemas in bulk.

Parameters:

paths - an iterable of paths pointing to JSON schema documents

Returns:

the builder

Throws:

MalformedURLException

See Also:

• addJsonSchema(Path)

addAllJsonSchemaUrls

public JsonSchemaValidationWorkflowRunnerBuilder<T> addAllJsonSchemaUrls(List<URL> urls)

Add JSON schemas in bulk.

Parameters:

urls - an iterable of urls pointing to JSON schema documents

Returns:

the builder

See Also:

• addJsonSchema(URL)

build

public abstract JsonSchemaValidationWorkflowRunner<T> build()

Finish building the JsonSchemaValidationWorkflowRunner.

Specified by:

build in class ValidationWorkflowRunnerBuilder<T extends com.google.protobuf.MessageOrBuilder>

Returns:

the runner