This project provides a Pepper module for the merging of data on several possible levels.
Clone or download
Pull request Compare This branch is 5 commits behind develop.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.settings
gh-site/img
src
.classpath
.gitignore
.project
LICENSE
NOTICE
README.md
build.properties
nb-configuration.xml
pom.xml
sample_workflow_kidko.html

README.md

SaltNPepper project

MergingModules

This project provides a manipulator to merge corpora from different sources. This module is implemented for the linguistic converter framework Pepper (see https://u.hu-berlin.de/saltnpepper). A detailed description of the manipulator can be found in Merger or in a poster presented at the DGfS 2014.

Pepper is a pluggable framework to convert a variety of linguistic formats (like TigerXML, the EXMARaLDA format, PAULA etc.) into each other. Furthermore Pepper uses Salt (see https://github.com/korpling/salt), the graph-based meta model for linguistic data, which acts as an intermediate model to reduce the number of mappings to be implemented. That means converting data from a format A to format B consists of two steps. First the data is mapped from format A to Salt and second from Salt to format B. This detour reduces the number of Pepper modules from n2-n (in the case of a direct mapping) to 2n to handle a number of n formats.

n:n mappings via SaltNPepper

In Pepper there are three different types of modules:

  • importers (to map a format A to a Salt model)
  • manipulators (to map a Salt model to a Salt model, e.g. to add additional annotations, to rename things to merge data etc.)
  • exporters (to map a Salt model to a format B).

For a simple Pepper workflow you need at least one importer and one exporter.

Requirements

Since the here provided module is a plugin for Pepper, you need an instance of the Pepper framework. If you do not already have a running Pepper instance, click on the link below and download the latest stable version (not a SNAPSHOT):

Note: Pepper is a Java based program, therefore you need to have at least Java 7 (JRE or JDK) on your system. You can download Java from https://www.oracle.com/java/index.html or http://openjdk.java.net/ .

Install module

If this Pepper module is not yet contained in your Pepper distribution, you can easily install it. Just open a command line and enter one of the following program calls:

Windows

pepperStart.bat 

Linux/Unix

bash pepperStart.sh 

Then type in command is and the path from where to install the module:

pepper> update de.hu_berlin.german.korpling.saltnpepper::pepperModules-MergingModules::https://korpling.german.hu-berlin.de/maven2/

Usage

To use this module in your Pepper workflow, put the following lines into the workflow description file. Note the fixed order of xml elements in the workflow description file: <importer/>, <manipulator/>, <exporter/>. The Merger is a manipulator module, which can be addressed by one of the following alternatives. A detailed description of the Pepper workflow can be found on the Pepper project site.

a) Identify the module by name

<manipulator name="Merger"/>

b) Use properties

<manipulator name="Merger">
  <property key="PROPERTY_NAME">PROPERTY_VALUE</property>
</manipulator>

Contribute

Since this Pepper module is under a free license, please feel free to fork it from github and improve the module. If you even think that others can benefit from your improvements, don't hesitate to make a pull request, so that your changes can be merged. If you have found any bugs, or have some feature request, please open an issue on github. If you need any help, please write an e-mail to saltnpepper@lists.hu-berlin.de .

Funders

This project has been funded by the department of corpus linguistics and morphology of the Humboldt-Universität zu Berlin and the Sonderforschungsbereich 632.

License

Copyright 2014 Humboldt-Universität zu Berlin.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Merger

The Merger allows to merge an unbound number of corpora to a single corpus with Pepper. The Merger can be integrated in a Pepper workflow as a step of the manipulation phase. The merging is along the document structure, but before two or more document structures can be merged to a single one, two corresponding document structures have to be identified. The identification of merging partners is based on the name and the path of a document in the corpus structure. The merging of the content is based on the textual data. Only documents having an equal textual datasource or at least one is contained in the other are mergable. Basing on the textual alignment, the mergable tokens can be computed. In the last step these tokens are the base for the merging of the rest of the graph structure like SSpan or SStructure nodes and relations.

Properties

The merging can be customized by using the properties listed in the following table.

name of property possible values default value
punctuations String '.',',',':',';','!','?','(',')','{','}','<','>'
escapeMapping String
copyNodes true, false false
firstAsBase true, false false

punctuations

Determines the punctuation characters used to be ignored for detecting equal textual data. The value is a comma separated list, each entry must be surrounded by a quot: 'PUNCTUATION' (, 'PUNCTUATION')* . For instance:

<property key="punctuations">'.',',',':',';','!','?','(',')','{','}','<','>'</property>

escapeMapping

Determines the mapping used in normalization step, to map special characters like umlauts. This value is a comma separated list of mappings: "REPLACED_CHARACTER" : "REPLACEMENT" (, "REPLACED_CHARACTER" : "REPLACEMENT")*. For instance:

<property key="escapeMapping">"ä":"ae","ö":"oe","ü":"ue","ß":"ss"</property>

copyNodes

Determines if SSpan and SStructure nodes should be copied or merged. Merged means to move all annotations to the equivalent in base document. If value is true they will be copied. To illustrate the behavior, imagine the following two document structures:

document structure 1:    |    document structure 2:
                         |
span1(a=b)               |    spanA(d=c)
   |                     |       |
  tok1                   |      tokA

For this example we assume, that tok1 of document structure 1 and tokA of document structure 2, as well as span1 and spanA are merging partners. The next figure shows both results, first when setting true and second when setting false.

true:                    |  false:
                         |
span1(a=b)   span2(c=d)  |  span1(a=b, c=d)
       \    /            |     |
        tok1             |    tok1

firstAsBase

If this property is set to 'true', the base document is always the one, which belongs to the first SCorpusGraph (the first importer in Pepper workflow description). The value either could be 'true' or 'false'. If this value is set to false, the base document is computed automically (normally the one with the largest primary text).

Identification of mergable documents

To give an example of the identification of merging partners for documents, imagine two corpus structures comming from different sources, one for instance from a TIGER XML corpus and the other one from a EXMARaLDA corpus. Since neither TIGER XML nor EXMARaLDA encode the corpus structure explicitly, it is taken from the folder structure, the corpus is organized in. For our example, the root folder, which is addressed by the importer is both times the folder 'myCorpus'. This folder contains two sub-folders 'subCorpus1' and 'subCorpus2'. Each folder further contains two documents, the TIGER XML or EXMARaLDA files.

  1. TIGER XML

    myCorpus
    |
    +--subCorpus1
    |  |
    |  +--document1.xml
    |  |
    |  +--document2.xml
    |
    +--subCorpus2
       |
       +--document3.xml
       |
       +--document4.xml
    
  2. EXMARaLDA

    myCorpus
    |
    +--subCorpus1
    |  |
    |  +--document1.exb
    |  |
    |  +--document2.exb
    |
    +--subCorpus2
       |
       +--document3.exb
       |
       +--document4.exb
    

The merging partners in that example would be the documents:

  1. myCorpus/subCorpus1/document1 from the TIGER XML sample and myCorpus/subCorpus1/document1 from the EXMARaLDA corpus and so on
  2. myCorpus/subCorpus1/document2 from the TIGER XML sample and myCorpus/subCorpus1/document2 from the EXMARaLDA corpus and so on

Mergability of textual datasources

To find potentially mergable textual datasources, the Merger iterates over all textual datasources of both documents, normalizes and compares them. For instance imagine the two texts:

  1. This is a sample text.
  2. This IS aSAMPLE

Both text do not differ in their content, but in their form. Therefore they are normalized, by removing whitespaces and changing the case to lower case:

  1. thisisasampletext.
  2. thisisasample

After normalizing, both texts are compared by String comparision. In our case, the second text is a substring of the first text and therefore the texts are mergable (the same goes, if both texts are equal or text 1 is a subset of text 2). When two mergable texts are found, an offset mapping is computed, which maps the normalized text to the original text. For the first text, this will result in the following map:

character normalized text original text
t 1 1
h 2 2
i 3 3
s 4 4
i 5 6
s 6 7
a 7 9
s 8 11
a 9 12
m 10 13
... ... ...

For the second text, this will result in the following map:

character normalized text original text
t 1 1
h 2 2
i 3 3
s 4 4
i 5 12
s 6 13
a 7 15
s 8 16
a 9 17
m 10 18
... ... ...

With these maps the offsets for tokens pointing to the textual datasource can be mapped between the two documents using the normalized text as base.

Merging of tokens, other nodes and edges

For each token it is now possible to detect if there is a merging partner in the other document or not with the use of the computed offsets. In our example let the first text be tokenized as follows: tok1(this), tok2(is), tok3(a), ... . And let the second text be tokenized like this: tokA(this), tokB(is), tokC(a), ... . Regarding the offsets of the normalized columns of both tables we can align the tokens of both texts by their start and end position. A mapping would look like this:

tok1 --> tokA : start: 1, end: 3 tok2 --> tokB : start: 4, end: 5 tok3 --> tokC : start: 6, end: 6 ... These pairs are the merging partners. When there is a merging partner, all annotations of that token are copied. In case, there is no merging partner, a token is copied from one document to the other. Since Salt is a graph based model, each linguistic annotation and structure is modeled as either a node an edge or a label. That means, basing on tokens, the graphs can be traversed in a bottom up like traversal to visit each node and each edge. To be more precise we give an example. Imagine the two following document structures:

  1. document structure 1

          a
      /   |   \
    tok1 tok2 tok3
    
  2. document structure 2

          b
      /   |   \
    tokA tokB tokC
    

We assume, that the tokens tok1 and tokA, tok2 and tokB, tok3 and tokC are mergable. When node a is reached by the traversal, all child nodes of a will be collected. For each node in this collection the corresponding one of document structure 2 is put into another collection (containing tokA, tokB and tokC). Starting with this collection, a node in document structure 2 is searched, which is a parent node of all of them. This leads to node b. And finally node b is merged with node a. This process is continued until each node was merged (if it is mergable).