Package org.phenopackets.phenopackettools.validator.core
Actors
This section describes the actors of the validation workflow (the classes for representing behavior for "doing stuff"), starting from the basic elements.
PhenopacketFormatConverters is a static factory class
for providing PhenopacketFormatConverters to convert
the top-level elements of Phenopacket Schema between the supported
PhenopacketFormats.
PhenopacketValidator represents a single step
of the validation workflow.
ValidationWorkflowRunner applies
the PhenopacketValidators of the validation workflow in
the correct order, ensuring the base validation is always run as first.
The ValidationWorkflowRunner validates
a top-level element.
The ValidationWorkflowDispatcher exposes methods
for validating all top-level elements of the Phenopacket Schema.
Value objects
The package includes stateful objects with no complex behavior starting from the most complex objects.
The ValidationWorkflowRunner
and ValidationWorkflowDispatcher return
ValidationResults, a container with results
of the validation workflow.
ValidationResult contains results of
a single validation step.
ValidatorInfo describes
the PhenopacketValidator.
-
ClassDescriptionA
PhenopacketToolsExceptionthat is thrown byPhenopacketConverterin case the provided data has incorrect format.PhenopacketFormatConverter<T extends com.google.protobuf.MessageOrBuilder>The implementors allow to convert between formats of the top-level elements of Phenopacket schema.Static class to getPhenopacketFormatConverters for top-level elements of the Phenopacket schema.PhenopacketValidator<T extends com.google.protobuf.MessageOrBuilder>PhenopacketValidatorrepresents a single step of the validation workflow.ValidationLevelrepresents a severity level forValidationResult.ValidationResultcontains results of a single validation step performed by aPhenopacketValidator.ValidationResultscontain validation results for one Phenopacket schema top-level element (Phenopacket,Family, orCohort).A builder for creatingValidationResults.ValidationWorkflowDispatcherexposes endpoints for validating top-level elements of Phenopacket Schema and dispatches the data into the appropriateValidationWorkflowRunner.ValidationWorkflowRunner<T extends com.google.protobuf.MessageOrBuilder>ValidationWorkflowRunnervalidates selected top-level element of the Phenopacket Schema.ValidationWorkflowRunnerBuilder<T extends com.google.protobuf.MessageOrBuilder>The base builder for constructingValidationWorkflowRunner.A description of aPhenopacketValidator.