Resolve #129 - Api Doc Updates

src/test/java/de/kosit/validationtool/docs/MiscDocExampleCodes.java

@@ -0,0 +1,51 @@
+package de.kosit.validationtool.docs;
+
+import java.net.URI;
+
+import javax.xml.transform.URIResolver;
+import javax.xml.validation.Schema;
+import javax.xml.validation.SchemaFactory;
+import javax.xml.validation.Validator;
+
+import de.kosit.validationtool.api.Configuration;
+import de.kosit.validationtool.api.ResolvingConfigurationStrategy;
+import de.kosit.validationtool.impl.ResolvingMode;
+import de.kosit.validationtool.impl.xml.ProcessorProvider;
+import net.sf.saxon.lib.UnparsedTextURIResolver;
+
+public class MiscDocExampleCodes {
+
+    void m1() {
+        final Configuration config = Configuration.load(URI.create("myscenarios.xml")).setResolvingMode(ResolvingMode.STRICT_LOCAL)
+                .build(ProcessorProvider.getProcessor());
+    }
+
+    private static final class MyCustomResolvingConfigurationStrategy implements ResolvingConfigurationStrategy {
+
+        public SchemaFactory createSchemaFactory() {
+            // TODO
+            return null;
+        }
+
+        public URIResolver createResolver(final URI scenarioRepository) {
+            // TODO
+            return null;
+        }
+
+        public UnparsedTextURIResolver createUnparsedTextURIResolver(final URI scenarioRepository) {
+            // TODO
+            return null;
+        }
+
+        public Validator createValidator(final Schema schema) {
+            // TODO
+            return null;
+        }
+    }
+
+    void m2() {
+        final Configuration config = Configuration.load(URI.create("myscenarios.xml"))
+                .setResolvingStrategy(new MyCustomResolvingConfigurationStrategy()).build(ProcessorProvider.getProcessor());
+    }
+
+}

src/test/java/de/kosit/validationtool/docs/MyValidator.java

@@ -0,0 +1,31 @@
+package de.kosit.validationtool.docs;
+
+import static de.kosit.validationtool.config.ConfigurationBuilder.fallback;
+import static de.kosit.validationtool.config.ConfigurationBuilder.report;
+import static de.kosit.validationtool.config.ConfigurationBuilder.scenario;
+import static de.kosit.validationtool.config.ConfigurationBuilder.schema;
+import static de.kosit.validationtool.config.ConfigurationBuilder.schematron;
+
+import java.net.URI;
+import java.nio.file.Paths;
+
+import de.kosit.validationtool.api.Check;
+import de.kosit.validationtool.api.Configuration;
+import de.kosit.validationtool.impl.DefaultCheck;
+import de.kosit.validationtool.impl.xml.ProcessorProvider;
+
+/**
+ * Example code that is used in the docs/api.md file
+ */
+public class MyValidator {
+
+    public static void main(final String[] args) {
+        final Configuration config = Configuration.create().name("myconfiguration")
+                .with(scenario("firstScenario").match("//myNode").validate(schema("Sample Schema").schemaLocation(URI.create("simple.xsd")))
+                        .validate(schematron("my rules").source("myRules.xsl")).with(report("my report").source("report.xsl")))
+                .with(fallback().name("default-report").source("fallback.xsl")).useRepository(Paths.get("/opt/myrepository"))
+                .build(ProcessorProvider.getProcessor());
+        final Check validator = new DefaultCheck(config);
+        // .. run your checks
+    }
+}

src/test/java/de/kosit/validationtool/docs/StandardExample.java

@@ -0,0 +1,54 @@
+package de.kosit.validationtool.docs;
+
+import java.net.URISyntaxException;
+import java.net.URL;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+import org.w3c.dom.Document;
+
+import de.kosit.validationtool.api.Check;
+import de.kosit.validationtool.api.Configuration;
+import de.kosit.validationtool.api.Input;
+import de.kosit.validationtool.api.InputFactory;
+import de.kosit.validationtool.api.Result;
+import de.kosit.validationtool.impl.DefaultCheck;
+import de.kosit.validationtool.impl.xml.ProcessorProvider;
+
+/**
+ * Example code that is used in the docs/api.md file
+ */
+public class StandardExample {
+
+    public void run(final Path testDocument) throws URISyntaxException {
+        // Load scenarios.xml from classpath
+        final URL scenarios = this.getClass().getClassLoader().getResource("examples/simple/scenarios-with-relative-paths.xml");
+        // Load the rest of the specific Validator configuration from classpath
+        final Configuration config = Configuration.load(scenarios.toURI()).build(ProcessorProvider.getProcessor());
+        // Use the default validation procedure
+        final Check validator = new DefaultCheck(config);
+        // Validate a single document
+        final Input document = InputFactory.read(testDocument);
+        // Get Result including information about the whole validation
+        final Result report = validator.checkInput(document);
+        System.out.println("Is processing succesful=" + report.isProcessingSuccessful());
+        // Get report document if processing was successful
+        Document result = null;
+        if (report.isProcessingSuccessful()) {
+            result = report.getReportDocument();
+        }
+        // continue processing results...
+    }
+
+    public static void main(final String[] args) throws Exception {
+        // Use e.g. "src/test/resources/examples/simple/input/foo.xml"
+        if (args.length == 0) {
+            throw new IllegalStateException("Provide a test document filename on the commandline");
+        }
+        // Path of document for validation
+        final Path testDoc = Paths.get(args[0]);
+        final StandardExample example = new StandardExample();
+        // run example validation
+        example.run(testDoc);
+    }
+}