This project provides a manipulator to move annotations in a document from one object to another, for example to move an edge annotation from the edge to a source or target node, or from a node to another node.
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 Mover 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.
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.
Since the module provided here 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/ .
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/
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 Mover 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.
<manipulator name="Mover"/><manipulator name="Mover">
<property key="PROPERTY_NAME">PROPERTY_VALUE</property>
</manipulator>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 .
This project module was developed at Georgetown University.
Copyright 2017-2019 Amir Zeldes, Georgetown University.
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.
The Mover adds token number annotations to tokens and optionally a metadatum with the total count of tokens. The Mover can be integrated in a Pepper workflow as a step of the manipulation phase.
The manipulation process can be customized by using the properties listed in the following table.
| name of property | possible values | default value |
|---|---|---|
| Mover.sourceType | {edge,source2target,tok2node,edge2edge} | 'edge' |
| Mover.sourceName | String | 'dep' |
| Mover.sourceLayer | String | NULL |
| Mover.sourceAnno | String | 'func' |
| Mover.sourceAnnoVal | Regular expression | NULL |
| Mover.sourceAnnoNamespace | String | NULL |
| Mover.targetObject | {source,target,span,struct} | 'target' |
| Mover.targetNamespace | String | NULL |
| Mover.targetAnno | String | NULL |
| Mover.targetAnnoVal | String | NULL |
| Mover.targetLayer | String | NULL |
| Mover.targetName | String | NULL |
| Mover.removeOrig | Boolean | false |
Specifies where the moved annotation comes from: an 'edge' (default), a node which is connected to the target by an edge (source2target), or a token annotation which should be moved to a new non-terminal node (tok2node).
Specifies the name of the type of source object, i.e. an edge type if sourceType is 'edge' or 'source2target' (default: 'dep')
Specifies a layer name to restrict source objects to. (default: NULL)
Specifies the annotation name to be moved (default: 'func')
A regular expression matching some annotation values of an edge as a condition for moving
Specifies the namespace of the annotation to be moved.
One of: source (move an edge annotation to the edge source node), target (the opposite), span (the new node type for tok2node), struct (for tok2node)
Namespace to assign to the new annotation. If unspecified, it will be copied from the source annotation.
Annotation name to assign to the new annotation. If unspecified, it will be copied from the source annotation.
A fixed value to assign to the new annotation. If unspecified, it will be copied from the source annotation.
A name to assign to the layer containing generated target objects (i.e. nodes above tokens in tok2node mode)
A name to assign to the generated target objects (i.e. edge type in edge2edge mode)
Whether to remove the original annotation after moving (default: false)
Here are some useful example scenarios for using this module.
Copy a parent lemma from a dependency parent to a dependency child:
<manipulator name="Mover">
<property key="Mover.sourceType">source2target</property>
<property key="Mover.sourceName">dep</property>
<property key="Mover.sourceAnno">lemma</property>
<property key="Mover.sourceAnnoNamespace">default_ns</property>
<property key="Mover.targetAnno">parent_lemma</property>
<property key="Mover.targetObject">target</property>
</manipulator>
Insert a fixed node annotation anaphoric=anaphor for any node with an outgoing coref edge:
<manipulator name="Mover">
<property key="Mover.sourceName">coref</property>
<property key="Mover.sourceLayer">coref</property>
<property key="Mover.targetNamespace">coref</property>
<property key="Mover.targetAnno">anaphoric</property>
<property key="Mover.targetAnnoVal">anaphor</property>
<property key="Mover.targetObject">source</property>
</manipulator>
Move a morphological token annotation to a span above that token:
<manipulator name="Mover">
<property key="Mover.sourceType">tok2node</property>
<property key="Mover.sourceName">morph</property>
<property key="Mover.targetNamespace">morph_span</property> <!-- if unused, target NS will also be 'morph' -->
<property key="Mover.targetAnno">morph_span</property> <!-- if unused, target annotation will also be 'morph' -->
<property key="Mover.targetObject">span</property> <!-- can also use 'struct' -->
<property key="Mover.targetLayer">morph</property>
</manipulator>
Split some annotated edges into a new edge type:
<manipulator name="Mover">
<property key="Mover.sourceType">edge2edge</property>
<property key="Mover.sourceLayer">ref</property> <!-- find edges from the layer ref -->
<property key="Mover.sourceAnno">type</property> <!-- make sure they have a type annotation -->
<property key="Mover.sourceAnnoVal">bridg.*</property> <!-- check that the annotation value matches bridg.* -->
<property key="Mover.targetName">bridge</property> <!-- for the matched edges, make a new edge type 'bridge' -->
<property key="Mover.targetLayer">bridge</property> <!-- place them in a layer 'bridge' -->
<property key="Mover.targetAnno">type</property> <!-- add an annotation 'type', copy value from original annotation if not specified -->
<property key="Mover.removeOrig">TRUE</property> <!-- delete the original matched edges -->
</manipulator>