main.zone.cogni.semanticz.shaclviz.CLI.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of semanticz-shaclviz Show documentation

A tool to create flexible SHACL diagrams in PlantUML or yEd

There is a newer version: 1.0.2

package zone.cogni.semanticz.shaclviz

import com.github.ajalt.clikt.core.CliktCommand
import com.github.ajalt.clikt.core.Context
import com.github.ajalt.clikt.core.main
import com.github.ajalt.clikt.parameters.arguments.argument
import com.github.ajalt.clikt.parameters.options.default
import com.github.ajalt.clikt.parameters.options.option
import org.apache.jena.query.QueryFactory
import org.apache.jena.rdf.model.ModelFactory
import zone.cogni.semanticz.shaclviz.export.Exporter
import zone.cogni.semanticz.shaclviz.model.Graph
import zone.cogni.semanticz.shaclviz.util.Utils.loadResourceContent
import java.io.File

class Generate : CliktCommand() {
    private val modelFile by argument(name = "--modelFile", help = "The SHACL model file to process.")
    private val outputFile by argument(name = "--outputFile", help = "The output file to write the diagram to.")
    private val graphQuery by option(
        "--graphQuery",
        help = "Optional Definition of a query to generate the graph constraints."
    )
        .default("classpath:/shacl-datamodel-view.rq")
    private val filterQuery by option(
        "--filterQuery",
        help = "Optional Definition of a query to filter constraints."
    ).default("classpath:/edges-all.rq")
    private val fieldQuery by option(
        "--fieldQuery",
        help = "Selects additional IRIs to be displayed as fields."
    ).default("classpath:/fields-datatypes.rq")
    private val outputFormat by option(
        "--outputFormat",
        help = """Graph format:
            - 'puml' - PlantUML diagram format. Suitable for quick visualization.
            - 'tgf' - Trivial Graph Format importable by yEd. Suitable for full control over layout and further postprocessing.""".trimMargin()
    ).default("puml")

    private val hideOrphanNodes by option(
        "--hideOrphanNodes",
        help = """In case a node has not inbound/outbound connection and no fields, it is hidden.""".trimMargin()
    ).default("true")

    override fun help(context: Context) = "Generates a diagram"
    override fun run() {
        val model = ModelFactory.createDefaultModel().read(modelFile)
        val graphQuery = QueryFactory.create(loadResourceContent(graphQuery))
        val filterQuery = QueryFactory.create(loadResourceContent(filterQuery))
        val fieldQuery = QueryFactory.create(loadResourceContent(fieldQuery))
        val writer = File(outputFile).bufferedWriter()
        val exporter = Exporter.get(outputFormat)
        Graph().apply {
            parse(model, graphQuery, filterQuery, fieldQuery)
            exporter.export(this, writer, hideOrphanNodes.toBoolean())
        }
        writer.close()
    }
}

fun main(args: Array) = Generate().main(args)