demo/validator
1
0
Fork 0
mirror of https://github.com/itplr-kosit/validator.git synced 2026-05-25 16:55:39 +00:00
Code Issues Projects Releases Packages Wiki Activity

javadoc translations

Browse source
This commit is contained in:
Andreas Penski (init) 2020-08-12 10:13:56 +02:00
parent cc7bfb2250
commit f9c6248513
2 changed files with 21 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

31
src/main/java/de/kosit/validationtool/api/Check.java
View file

@ -26,18 +26,18 @@ import org.w3c.dom.Document;
/** /**
* Zentrale Schnittstellendefinition für das Prüf-Tool. * Main validator interface for checking incoming files.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
public interface Check { public interface Check {
/** /**
* Führt die konfigurierte Prüfung für die übergebene Resource aus. Das Ergebnis-{@link Document} ist readonly. Soll es * Checks an incoming xml {@link Input Inputs}. The result-{@link Document} is readonly. To change the this document you
* weiterverarbeitet werden, so muss es kopiert werden. * need to copy the nodes into an new {@link Document}.
* *
* @param input die Resource / XML-Datei, die geprüft werden soll. * @param input the resource / xml file to validate.
* @return ein Ergebnis-{@link Document} (readonly) * @return a result-{@link Document} (readonly)
*/ */
default Document check(final Input input) { default Document check(final Input input) {
final Result result = checkInput(input); final Result result = checkInput(input);
@ -46,29 +46,30 @@ public interface Check {
} }
/** /**
* Führt die konfigurierte Prüfung für die übergebene Resource aus. * Checks an incoming xml file.
* *
* @param input die Resource / XML-Datei, die geprüft werden soll. * @param input the resource / xml file to validate.
* @return ein Ergebnis-{@link Document} * @return a {@link Result} object
*/ */
Result checkInput(Input input); Result checkInput(Input input);
/** /**
* Führt eine Prüfung im Batch-Mode durch. Die Default-Implementierung führt die Prüfung sequentiell aus. Die Ergebnis * Checks an incoming xml files in batch mode. Processing is sequential. The result-{@link Document Documents} are
* -{@link Document Dokumente} sind readonly. Sollen sie weiterverarbeitet werden, so müssen Kopien erstellt werden. * readonly. To change the this document you need to copy them into new {@link Document Documents}.
* *
* @param input die Eingabe *
* @return Liste mit Ergebnis-Dokumenten (readonly) * @param input list of xml {@link Input Inputs}
* @return list of result-{@link Document Documents} (readonly)
*/ */
default List<Document> check(final List<Input> input) { default List<Document> check(final List<Input> input) {
return input.stream().map(this::check).collect(Collectors.toList()); return input.stream().map(this::check).collect(Collectors.toList());
} }
/** /**
* Führt eine Prüfung im Batch-Mode durch. Die Default-Implementierung führt die Prüfung sequentiell aus. * Checks an incoming xml files in batch mode. Processing is sequential.
* *
* @param input die Eingabe * @param input list of xml {@link Input Inputs}
* @return Liste mit Ergebnis-Dokumenten * @return list of {@link Result}
*/ */
default List<Result> checkInput(final List<Input> input) { default List<Result> checkInput(final List<Input> input) {
return input.stream().map(this::checkInput).collect(Collectors.toList()); return input.stream().map(this::checkInput).collect(Collectors.toList());

10
src/main/java/de/kosit/validationtool/impl/DefaultCheck.java
View file

@ -51,8 +51,8 @@ import de.kosit.validationtool.model.reportInput.XMLSyntaxError;
import net.sf.saxon.s9api.Processor; import net.sf.saxon.s9api.Processor;
/** /**
* Die Referenz-Implementierung für den Prüfprozess. Nach initialer Konfiguration ist diese Klasse threadsafe und kann * The reference implementation for the validation process. After initialisation, instances are threadsafe and should be
* in Server-Umgebungen eingesetzt werden * reused since initializing saxon runtime objects is an rather heavyweight process.
* *
* @author Andreas Penski * @author Andreas Penski
*/ */
@ -68,9 +68,9 @@ public class DefaultCheck implements Check {
private final List<CheckAction> checkSteps; private final List<CheckAction> checkSteps;
/** /**
* Erzeugt eine neue Instanz mit der angegebenen Konfiguration. * Creates a new instance for the {@link Configuration}.
* *
* @param configuration die Konfiguration * @param configuration the Configuration
*/ */
public DefaultCheck(final Configuration configuration) { public DefaultCheck(final Configuration configuration) {
this.configuration = configuration; this.configuration = configuration;
@ -100,8 +100,6 @@ public class DefaultCheck implements Check {
return type; return type;
} }
@Override @Override
public Result checkInput(final Input input) { public Result checkInput(final Input input) {
final CheckAction.Bag t = new CheckAction.Bag(input, createReport()); final CheckAction.Bag t = new CheckAction.Bag(input, createReport());