Package name.jurgenei.gradle.xml

Class SchematronExtractTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
name.jurgenei.gradle.xml.SchematronExtractTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
@DisableCachingByDefault(because="Extraction output fan-out depends on source trees and dynamic grouped mappings") public abstract class SchematronExtractTask extends org.gradle.api.DefaultTask
Phase-3 runtime task that executes Schematron-based observation extraction.

The task can consume a precompiled extraction stylesheet or compile one on the fly from annotation-bearing Schematron rules.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.api.Named

    org.gradle.api.Named.Namer

  • Field Summary

    Fields inherited from interface org.gradle.api.Task

    TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

  • Constructor Summary

    Constructors
    Constructor
    Description
    SchematronExtractTask()
    Creates extraction task with fail-fast behavior enabled by default.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    extract()
    Runs observation extraction for all configured source files.
    abstract org.gradle.api.provider.Property<Boolean>
    getFailOnError()
    Controls build failure behavior when extraction errors occur.
    abstract org.gradle.api.provider.MapProperty<String,String>
    getGroupOutputs()
    Group-to-relative-path mapping for emitted observation documents.
    abstract org.gradle.api.file.DirectoryProperty
    getOutputDir()
    Output directory root for grouped extraction documents.
    abstract org.gradle.api.file.RegularFileProperty
    getSchema()
    Schematron schema containing observation rule metadata.
    abstract org.gradle.api.file.ConfigurableFileCollection
    getSourceFiles()
    Canonical XML sources used for extraction.
    abstract org.gradle.api.file.RegularFileProperty
    getStyle()
    Optional precompiled extraction stylesheet.
    void
    groupOutput(String group, String relativePath)
    Configures output path mapping for a logical group.
    void
    schema(Object path)
    Sets Schematron schema file.
    void
    source(Object source)
    Adds input source(s) using Gradle file notation.
    void
    source(Object sourceDir, org.gradle.api.Action<? super org.gradle.api.tasks.util.PatternFilterable> action)
    Adds source file tree include/exclude configuration.
    void
    style(Object path)
    Sets precompiled extraction stylesheet file.

    Methods inherited from class org.gradle.api.DefaultTask

    compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

    Methods inherited from class org.gradle.api.internal.AbstractTask

    acceptServiceReferences, appendParallelSafeAction, doNotTrackState, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, setImpliesSubProjects

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Constructor Details

    • SchematronExtractTask

      @Inject public SchematronExtractTask()
      Creates extraction task with fail-fast behavior enabled by default.

  • Method Details

    • getSchema

      @InputFile @PathSensitive(RELATIVE) public abstract org.gradle.api.file.RegularFileProperty getSchema()
      Schematron schema containing observation rule metadata.
      Returns:
      schema file property

    • getStyle

      @Optional @InputFile @PathSensitive(RELATIVE) public abstract org.gradle.api.file.RegularFileProperty getStyle()
      Optional precompiled extraction stylesheet.
      Returns:
      stylesheet property

    • getSourceFiles

      @InputFiles @PathSensitive(RELATIVE) public abstract org.gradle.api.file.ConfigurableFileCollection getSourceFiles()
      Canonical XML sources used for extraction.
      Returns:
      source file collection

    • getOutputDir

      @OutputDirectory public abstract org.gradle.api.file.DirectoryProperty getOutputDir()
      Output directory root for grouped extraction documents.
      Returns:
      output directory property

    • getGroupOutputs

      @Input public abstract org.gradle.api.provider.MapProperty<String,String> getGroupOutputs()
      Group-to-relative-path mapping for emitted observation documents.
      Returns:
      group output mapping

    • getFailOnError

      @Input public abstract org.gradle.api.provider.Property<Boolean> getFailOnError()
      Controls build failure behavior when extraction errors occur.
      Returns:
      fail-on-error property

    • schema

      public void schema(Object path)
      Sets Schematron schema file.
      Parameters:
      path - file notation accepted by Project.file.

    • style

      public void style(Object path)
      Sets precompiled extraction stylesheet file.
      Parameters:
      path - file notation accepted by Project.file.

    • source

      public void source(Object source)
      Adds input source(s) using Gradle file notation.
      Parameters:
      source - file, directory, fileTree, or collection.

    • source

      public void source(Object sourceDir, org.gradle.api.Action<? super org.gradle.api.tasks.util.PatternFilterable> action)
      Adds source file tree include/exclude configuration.
      Parameters:
      sourceDir - root directory.
      action - include/exclude action.

    • groupOutput

      public void groupOutput(String group, String relativePath)
      Configures output path mapping for a logical group.
      Parameters:
      group - observation group key.
      relativePath - output path under each input-stem root.

    • extract

      public void extract()
      Runs observation extraction for all configured source files.