Skip to content

Commit

Permalink
fix paths in ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
@jmkeil
jmkeil committed Mar 4, 2024
1 parent 4723bfe commit 15c56af
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ This will create a stand alone .jar file at [abecto-core/target/abecto-exec.jar]

## Configuration

The execution of ABECTO is configured in a plan file, which is an RDF dataset file ([TriG](https://www.w3.org/TR/trig/), [N-Quads](https://www.w3.org/TR/n-quads/), …), using the [ABECTO Vocabulary](http://w3id.org/abecto/vocabulary). For an example see the [tutorial configuration](src/test/resources/tutorial-configuration.trig). Further build in processors can be found in the section [ABECTO Processors](#abecto-processors).
The execution of ABECTO is configured in a plan file, which is an RDF dataset file ([TriG](https://www.w3.org/TR/trig/), [N-Quads](https://www.w3.org/TR/n-quads/), …), using the [ABECTO Vocabulary](http://w3id.org/abecto/vocabulary). For an example see the [tutorial configuration](abecto-core/src/test/resources/tutorial-configuration.trig). Further build in processors can be found in the section [ABECTO Processors](#abecto-processors).

### How to write an ABECTO plan?

Expand Down Expand Up @@ -232,15 +232,15 @@ Compares and evaluates several RDF datasets.
Examples:
* show the help message:
```shell
java -jar target/abecto.jar --help
java -jar abecto-core/target/abecto-exec.jar --help
```
* run the tutorial plan and store the result:
```shell
java -jar target/abecto.jar --trig result.trig src/test/resources/tutorial-configuration.trig
java -jar abecto-core/target/abecto-exec.jar --trig result.trig abecto-core/src/test/resources/tutorial-configuration.trig
```
* create a deviations report for a specific dataset and without re-running the plan:
```shell
java -jar target/abecto.jar --loadOnly --reportOn "http://example.org/dataset1" --export deviations=deviations.csv result.trig
java -jar abecto-core/target/abecto-exec.jar --loadOnly --reportOn "http://example.org/dataset1" --export deviations=deviations.csv result.trig
```

## Annotating Known Wrong Values
Expand Down Expand Up @@ -322,7 +322,7 @@ We use the following prefix to abbreviate the namespace in the processor IRIs:

Source Processors load RDF data from different sources and store them in the internal triple store for further processing.

The **[File Source Processor](src/main/java/de/uni_jena/cs/fusion/abecto/processor/FileSourceProcessor.java)** (`abecto:FileSourceProcessor`) loads RDF data from one or multiple locale files of one of the following formats: RDF/XML, TriG, N-Quads, Turtle, N-Triples, JSON-LD, SHACL Compact Syntax, TriX, and RDF Thrift.
The **[File Source Processor](abecto-core/src/main/java/de/uni_jena/cs/fusion/abecto/processor/FileSourceProcessor.java)** (`abecto:FileSourceProcessor`) loads RDF data from one or multiple locale files of one of the following formats: RDF/XML, TriG, N-Quads, Turtle, N-Triples, JSON-LD, SHACL Compact Syntax, TriX, and RDF Thrift.
The format is automatically detected.
The processor has the following parameter:

Expand All @@ -331,7 +331,7 @@ The processor has the following parameter:
| path | One or multiple paths of RDF files that will be loaded. | |
A path may either be absolute, or relative to the configuration file.

The **[SPARQL Source Processor](src/main/java/de/uni_jena/cs/fusion/abecto/processor/SparqlSourceProcessor.java)** (`abecto:SparqlSourceProcessor`) loads RDF data from a SPARQL endpoint.
The **[SPARQL Source Processor](abecto-core/src/main/java/de/uni_jena/cs/fusion/abecto/processor/SparqlSourceProcessor.java)** (`abecto:SparqlSourceProcessor`) loads RDF data from a SPARQL endpoint.
This makes ABECTO independent of the availability of knowledge graphs RDF dumps and may avoid the handling of large dump files, if only a small share of the data is needed.
The resources of interest get defined by a SPARQL query, a list, or both.
The processor partitions the requested resources into chunks and loads all statements containing resources of the chunk as subject or object.
Expand All @@ -354,7 +354,7 @@ The processor has the following parameters:
| ignoreInverse | Properties to ignore in inverse direction. Statements with one of these properties will neither get loaded nor will their subjects become an associated resource. | |
| maxRetries | Total maximum number of retries of failed request to the source SPARQL endpoint. | 128 |

The **[URL Source Processor](src/main/java/de/uni_jena/cs/fusion/abecto/processor/UrlSourceProcessor.java)** (`abecto:UrlSourceProcessor`) loads RDF data from one or multiple remote files of one of the following formats: RDF/XML, TriG, N-Quads, Turtle, N-Triples, JSON-LD, SHACL Compact Syntax, TriX, and RDF Thrift.
The **[URL Source Processor](abecto-core/src/main/java/de/uni_jena/cs/fusion/abecto/processor/UrlSourceProcessor.java)** (`abecto:UrlSourceProcessor`) loads RDF data from one or multiple remote files of one of the following formats: RDF/XML, TriG, N-Quads, Turtle, N-Triples, JSON-LD, SHACL Compact Syntax, TriX, and RDF Thrift.
The format is automatically detected.
The processor has the following parameter:

Expand All @@ -367,14 +367,14 @@ The processor has the following parameter:
Transformation processors derive additional primary data from the existing primary data.
For example, this enables the derivation of implicit statements or the adjustment of value formatting for the mapping or comparison.

The **[Forward Rule Reasoning Processor](src/main/java/de/uni_jena/cs/fusion/abecto/processor/ForwardRuleReasoningProcessor.java)** (`abecto:ForwardRuleReasoningProcessor`) applies forward rules to derive additional primary data.
The **[Forward Rule Reasoning Processor](abecto-core/src/main/java/de/uni_jena/cs/fusion/abecto/processor/ForwardRuleReasoningProcessor.java)** (`abecto:ForwardRuleReasoningProcessor`) applies forward rules to derive additional primary data.
The processor has the following parameter:

| name | description | default |
|-------|------------------------------------------------------------------------------------------------------------------------------------------|---------|
| rules | The rules to apply on the primary data using the [Apache Jena rule syntax](https://jena.apache.org/documentation/inference/#RULEsyntax). | |

The **[SPARQL Construct Processor](src/main/java/de/uni_jena/cs/fusion/abecto/processor/SparqlConstructProcessor.java)** (`abecto:SparqlConstructProcessor`) applies a SPARQL construct query on the primary data of a knowledge graph to derive additional primary data.
The **[SPARQL Construct Processor](abecto-core/src/main/java/de/uni_jena/cs/fusion/abecto/processor/SparqlConstructProcessor.java)** (`abecto:SparqlConstructProcessor`) applies a SPARQL construct query on the primary data of a knowledge graph to derive additional primary data.
The query execution will be repeated until a configured limit of execution or no new statements have been produced.
The processor has the following parameters:

Expand All @@ -393,7 +393,7 @@ A rule reasoner is used to derive implicit correspondences and correspondence ex
The reasoning applies immediately on new correspondences to consider them during the further mapping processor execution.
Additionally, the inferences get persisted after a mapping processor execution succeeded.

The **[Equivalent Value Mapping Processor](src/main/java/de/uni_jena/cs/fusion/abecto/processor/EquivalentValueMappingProcessor.java)** (`abecto:EquivalentValueMappingProcessor`) provides correspondences between resources of one aspect in different knowledge graphs, if they have equivalent values for all given variables.
The **[Equivalent Value Mapping Processor](abecto-core/src/main/java/de/uni_jena/cs/fusion/abecto/processor/EquivalentValueMappingProcessor.java)** (`abecto:EquivalentValueMappingProcessor`) provides correspondences between resources of one aspect in different knowledge graphs, if they have equivalent values for all given variables.
This is similar to the inferences of an OWL reasoner on inverse functional properties.
Values are treated as equivalent if they are equivalent literals or if they are resources that are already known to correspond.
If multiple values exist for one variable, only one pair of values must be equivalent.
Expand All @@ -405,7 +405,7 @@ The processor has the following parameters:
| aspect | The aspects for which the correspondences get generated. | |
| variables | One or multiple variables that will be compared to determine the correspondence of resources. | |

The **[Functional Mapping Processor](src/main/java/de/uni_jena/cs/fusion/abecto/processor/FunctionalMappingProcessor.java)** (`abecto:FunctionalMappingProcessor`) provides correspondences based on links from resources of another aspect.
The **[Functional Mapping Processor](abecto-core/src/main/java/de/uni_jena/cs/fusion/abecto/processor/FunctionalMappingProcessor.java)** (`abecto:FunctionalMappingProcessor`) provides correspondences based on links from resources of another aspect.
If corresponding resources from different knowledge graphs link with a given variable two resources, these resources will be considered to correspond.
This is similar to the inferences of an OWL reasoner on functional properties.
The processor has the following parameters:
Expand All @@ -416,7 +416,7 @@ The processor has the following parameters:
| referringVariable | The variable linking the resources to map. | |
| referredAspect | The aspect of the resources to map. | |

The **[Jaro-Winkler Mapping Processor](src/main/java/de/uni_jena/cs/fusion/abecto/processor/JaroWinklerMappingProcessor.java)** (`abecto:JaroWinklerMappingProcessor`) provides correspondences based on the Jaro-Winkler Similarity (see [String Comparator Metrics and Enhanced Decision Rules in the Fellegi-Sunter Model of Record Linkage](http://eric.ed.gov/?id=ED325505)) of string values using our implementation for efficient bounded Jaro-Winkler similarity based search (see [Efficient Bounded Jaro-Winkler Similarity Based Search](http://doi.org/10.18420/btw2019-13)).
The **[Jaro-Winkler Mapping Processor](abecto-core/src/main/java/de/uni_jena/cs/fusion/abecto/processor/JaroWinklerMappingProcessor.java)** (`abecto:JaroWinklerMappingProcessor`) provides correspondences based on the Jaro-Winkler Similarity (see [String Comparator Metrics and Enhanced Decision Rules in the Fellegi-Sunter Model of Record Linkage](http://eric.ed.gov/?id=ED325505)) of string values using our implementation for efficient bounded Jaro-Winkler similarity based search (see [Efficient Bounded Jaro-Winkler Similarity Based Search](http://doi.org/10.18420/btw2019-13)).
Two resources are considered to correspond if for one variable in both directions the other variable value is the most similar value from the other knowledge graph and if the similarity score exceeds a threshold.
The processor has the following parameters:

Expand All @@ -427,7 +427,7 @@ The processor has the following parameters:
| threshold | The similarity threshold the variable values of two resources must comply. | |
| caseSensitive | Determines, if case is taken into account during the search for corresponding resources. | |

The **[Use Present Mapping Processor](src/main/java/de/uni_jena/cs/fusion/abecto/processor/UsePresentMappingProcessor.java)** (`abecto:UsePresentMappingProcessor`) provides correspondences based on existing links between resources in variable values.
The **[Use Present Mapping Processor](abecto-core/src/main/java/de/uni_jena/cs/fusion/abecto/processor/UsePresentMappingProcessor.java)** (`abecto:UsePresentMappingProcessor`) provides correspondences based on existing links between resources in variable values.
The processor has the following parameters:

| name | description | default |
Expand All @@ -440,7 +440,7 @@ The processor has the following parameters:
Comparison processors compare the primary data of the knowledge graphs using the correspondences provided by the mapping processors.
They provide annotations on specific values, resources, and knowledge graphs or determine measurements on the knowledge graphs.

The **[Population Comparison Processor](src/main/java/de/uni_jena/cs/fusion/abecto/processor/PopulationComparisonProcessor.java)** (`abecto:PopulationComparisonProcessor`) provides on the one hand [av:Issue](http://w3id.org/abecto/vocabulary#Issue) annotations for resource duplicates and [av:ResourceOmission](http://w3id.org/abecto/vocabulary#ResourceOmission) annotations.
The **[Population Comparison Processor](abecto-core/src/main/java/de/uni_jena/cs/fusion/abecto/processor/PopulationComparisonProcessor.java)** (`abecto:PopulationComparisonProcessor`) provides on the one hand [av:Issue](http://w3id.org/abecto/vocabulary#Issue) annotations for resource duplicates and [av:ResourceOmission](http://w3id.org/abecto/vocabulary#ResourceOmission) annotations.
On the other hand, it provides per knowledge graph measurements of

* the count ([av:count](http://w3id.org/abecto/vocabulary#count)) of resources of an aspect,
Expand All @@ -456,7 +456,7 @@ The processor has the following parameter:
|---------|-----------------------------------------------------------------------------------|---------|
| aspects | One or multiple aspects for which measurements and annotations will be generated. | |

The **[Property Comparison Processor](src/main/java/de/uni_jena/cs/fusion/abecto/processor/PropertyComparisonProcessor.java)** (`abecto:PropertyComparisonProcessor`) provides [av:Deviation](http://w3id.org/abecto/vocabulary#Deviation), [av:ValuesOmission](http://w3id.org/abecto/vocabulary#ValuesOmission), and [av:Issue](http://w3id.org/abecto/vocabulary#Issue) annotations on property values for one variable of corresponding resources.
The **[Property Comparison Processor](abecto-core/src/main/java/de/uni_jena/cs/fusion/abecto/processor/PropertyComparisonProcessor.java)** (`abecto:PropertyComparisonProcessor`) provides [av:Deviation](http://w3id.org/abecto/vocabulary#Deviation), [av:ValuesOmission](http://w3id.org/abecto/vocabulary#ValuesOmission), and [av:Issue](http://w3id.org/abecto/vocabulary#Issue) annotations on property values for one variable of corresponding resources.
On the other hand, it provides per knowledge graph measurements of

* the count ([av:count](http://w3id.org/abecto/vocabulary#count)) of resources of an aspect,
Expand Down Expand Up @@ -485,7 +485,7 @@ The processor has the following parameters:
| allowLangTagSkip | If true, literals of the type `xsd:string` or `rdf:langString` with equal lexical value but different language tag will match. | |
# ABECTO Reports

Reports are defined by one SPARQL query on the result multi graph and one [Apache FreeMarker](https://freemarker.apache.org/) template, located in [src/main/resources/de/uni_jena/cs/fusion/abecto/export](src/main/resources/de/uni_jena/cs/fusion/abecto/export).
Reports are defined by one SPARQL query on the result multi graph and one [Apache FreeMarker](https://freemarker.apache.org/) template, located in [abecto-core/src/main/resources/de/uni_jena/cs/fusion/abecto/export](abecto-core/src/main/resources/de/uni_jena/cs/fusion/abecto/export).
ABECTO provides the following built-in reports:

The **Deviations Report** (`deviations`) contrast the variable value of one resource with the deviating value of a corresponding resource in CSV format. In addition, it provides the aspect and the knowledge graphs of the resources, the step that mapped the resources, and an annotation snippet to mark the second value as wrong. Each entry is intended to be handled by one of the following options:
Expand Down

0 comments on commit 15c56af

Please sign in to comment.