API Reference

// Domain interface marker
interface RdfBacked {
    val rdf: RdfHandle
}

// RDF side-channel access
interface RdfHandle {
    val node: RdfTerm
    val graph: RdfGraph
    val extras: PropertyBag
    fun validate(): ValidationResult
    fun validateOrThrow()
}

// Unmapped property access
interface PropertyBag {
    fun predicates(): Set<Iri>
    fun values(pred: Iri): List<RdfTerm>
    fun literals(pred: Iri): List<Literal>
    fun strings(pred: Iri): List<String>
    fun iris(pred: Iri): List<Iri>
    fun <T : Any> objects(pred: Iri, asType: Class<T>): List<T>
}

object OntoMapper {
    fun <T : Any> register(type: Class<T>, factory: (RdfHandle) -> T)                   // fails if a different factory is registered
    fun <T : Any> register(type: Class<T>, replace: Boolean, factory: (RdfHandle) -> T)
    fun unregister(type: Class<*>): Boolean
    fun isRegistered(type: Class<*>): Boolean
    fun registeredTypes(): Set<Class<*>>
    fun <T : Any> materialize(ref: RdfRef, type: Class<T>): T
    fun <T : Any> materializeValidated(ref: RdfRef, type: Class<T>, validation: ValidationContext): T
}

fun RdfGraph.ref(node: RdfTerm): RdfRef
inline fun <reified T : Any> RdfGraph.materialize(node: RdfTerm): T
inline fun <reified T : Any> RdfGraph.materializeValidated(node: RdfTerm, validation: ValidationContext): T
inline fun <reified T : Any> RdfTerm.materializeIn(graph: RdfGraph): T
inline fun <reified T : Any> Iterable<RdfTerm>.materializeIn(graph: RdfGraph): List<T>
inline fun <reified T : Any> RdfRepository.materialize(node: RdfTerm, graph: RdfGraph = defaultGraph): T

inline fun <reified T : Any> RdfRef.asType(): T
inline fun <reified T : Any> RdfRef.asValidatedType(validation: ValidationContext): T
inline fun <reified T : Any> T.asRdf(): RdfHandle
fun <T : RdfBacked> T.writeToGraph(targetGraph: MutableRdfGraph, subject: Iri? = null)

interface ValidationContext : AutoCloseable {
    fun validate(data: RdfGraph, focus: RdfTerm): ValidationResult
    override fun close() {}
}

fun ValidationResult.orThrow()                                // throws on sh:Violation results only
fun ValidationResult.orThrow(minimumSeverity: ShaclSeverity)  // opt in to Warning / Info