Comet API - Docs/org.ragna.comet.validation

org.ragna.comet.validation

package org.ragna.comet.validation

Type members

Classlikes

class Validator[A](configuration: ValidatorConfiguration, extractor: StreamExtractor[A]) extends LazyLogging

Validator object capable of extracting data from a Stream and produce a stream of ValidationResults

Validator object capable of extracting data from a Stream and produce a stream of ValidationResults

The whole validation pipeline is done through FS2 streams, and flows as follows:

  1. A => RDF data: a Stream of data is received as instances of A that are parsed for RDF data (this functionality is delegated to StreamExtractors)

  2. RDF data => Validation Report => The parsed data is validated and the ValidationReports included on a new Stream

  3. Validation Report => Validation Result: The validated data is formatted and wrapped into instances of ValidationResult

Type parameters:
A

Type of the items being received via Stream and thus feeding the validator

Value parameters:
configuration

Configuration of this validator instance

extractor

Extractor providing access to the incoming RDF items

Throws:
StreamValidationException

When invalid or erroring items are found and the stream is configured to stop in such cases

Companion:
object
Source:
Validator.scala
private[comet] object Validator

Helper utilities for all Validators

Helper utilities for all Validators

Companion:
class
Source:
Validator.scala