Module org.phenopackets.phenopackettools.validator.core

Package org.phenopackets.phenopackettools.validator.core

Interface ValidatorInfo

public interface ValidatorInfo

A description of a PhenopacketValidator.

Method Summary

Modifier and Type	Method	Description
static ValidatorInfo	baseSyntaxValidation()
String	description()
static ValidatorInfo	inputValidator()	Get ValidatorInfo to represent anonymous validator to associate with errors related to data format errors.
static ValidatorInfo	of(String validatorId, String validatorName, String description)
String	validatorId()
String	validatorName()

Method Details

baseSyntaxValidation

static ValidatorInfo baseSyntaxValidation()

inputValidator

static ValidatorInfo inputValidator()

Get ValidatorInfo to represent anonymous validator to associate with errors related to data format errors.

The ValidatorInfo can be used if e.g. provided data is not a valid JSON but a valid JSON is expected.

of

static ValidatorInfo of(String validatorId,
 String validatorName,
 String description)

validatorId

String validatorId()

Returns:

string with a unique validator ID.

validatorName

String validatorName()

Returns:

human-friendly validator name.

description

String description()

Returns:

brief description of the validation provided by the validator.