Link Search Menu Expand Document

Packaging Matchers for SEALS

SEALS is a packaging format supported by most OAEI tracks. MELT allows to package and to evaluate SEALS matchers.

Package Your Matcher as SEALS Package with MELT

Package Your First Matcher

Prerequisites: Maven and Java must be installed.

  1. Copy the project in examples/simpleSealsMatcher to your workspace.
  2. Execute mvn clean package or mvn clean install.
  3. Check in the /target directory for your zip file (simple-SealsMatcher-1.0-seals_external.zip).

In More Detail

You can use the examples/simpleSealsMatcher as a template and change it according to your needs. However, if you take a close look, you can see that it is sufficient to use the pom.xml as template since the packaging is managed through maven.

You specify the matcher class in the <oaei.mainClass> tag. The matcher must implement interface IMatcher <ModelClass, AlignmentClass, ParameterClass>. Note that the easiest way to develop your system is to extend any of the convenience matcher classes such as MatcherURL, MatcherYAAAJena or MatcherYAAAOwlApi rather than implementing the interface yourself.

Evaluate Your SEALS Package Using the OAEI SEALS Client

You can set up the SEALS client locally and evaluate your matcher. You can find the documentation of the client here.

Alternatively, you can use the evaluation capabilities for SEALS packages by MELT as outlined below.

Evaluate and Re-Use a SEALS Package With MELT

Evaluation and Re-Use with MatcherSeals

Prerequisites: Java 8 (not necessarily as system Java distribution), maven project with dependency matching-eval.

It is recommended to use class MatcherSeals for wrapping any SEALS zip file as matcher. Since MatcherSeals implements MatcherURL, you can use an instantiated matcher with the default Executor to evaluate it (even together with non-SEALS matchers). You can also combine a MatcherSeals instance with any other matcher e.g. in a matching pipeline. Note: You do not have to install the SEALS client yourself. MELT takes care of this. Just wrap the SEALS zip file as shown in the example below.

Example

import de.uni_mannheim.informatik.dws.melt.matching_base.external.seals.MatcherSeals;
import de.uni_mannheim.informatik.dws.melt.matching_data.TrackRepository;
import de.uni_mannheim.informatik.dws.melt.matching_eval.ExecutionResultSet;
import de.uni_mannheim.informatik.dws.melt.matching_eval.Executor;
import de.uni_mannheim.informatik.dws.melt.matching_eval.evaluator.EvaluatorCSV;

public class SealsMatcherPlayground {
    public static void main(String[] args) {
        File sealsZip = new File("<SEALS ZIP FILE PATH>");
        String java8command = "<PATH TO JAVA 8 EXECUTABLE>";

        // let's instantiate our seals matcher wrapper:
        MatcherSeals matcherSeals = new MatcherSeals(sealsZip);

        // if you do not have Java 8 as system java:
        matcherSeals.setJavaCommand(java8command);

        // let's run the matcher:
        ExecutionResultSet ers = Executor.run(TrackRepository.Anatomy.Default.getFirstTestCase(), matcherSeals);

        // finally, let's evaluate the execution result
        EvaluatorCSV evaluatorCSV = new EvaluatorCSV(ers);
        evaluatorCSV.writeToDirectory();
    }
}

MatcherSeals is also available through a builder pattern via MatcherSealsBuilder:

Example

import de.uni_mannheim.informatik.dws.melt.matching_base.external.seals.MatcherSeals;
import de.uni_mannheim.informatik.dws.melt.matching_base.external.seals.MatcherSealsBuilder;
import de.uni_mannheim.informatik.dws.melt.matching_data.TrackRepository;
import de.uni_mannheim.informatik.dws.melt.matching_eval.ExecutionResultSet;
import de.uni_mannheim.informatik.dws.melt.matching_eval.Executor;
import de.uni_mannheim.informatik.dws.melt.matching_eval.evaluator.EvaluatorCSV;

import java.io.File;

public class SealsMatcherBuilderPlayground {

    public static void main(String[] args) {
        File sealsZip = new File("<SEALS ZIP FILE PATH>");
        String java8command = "<JAVA 8 EXECUTABLE>";
        MatcherSeals matcherSeals = new MatcherSealsBuilder()
                .setJavaCommand(java8command)
                .build(sealsZip);

        ExecutionResultSet ers = Executor.run(TrackRepository.Anatomy.Default.getFirstTestCase(), matcherSeals);
        EvaluatorCSV evaluatorCSV = new EvaluatorCSV(ers);
        evaluatorCSV.writeToDirectory();
    }
}

MatcherSeals (and similarly MatcherSealsBuilder) offer a multitude of configuration options. Have a look at the API documentation for details.

IMPORTANT: MatcherSeals internally executes the SEALS client which only work with Java 8. Thus it is necessary to have a Java 8 installation on your device. If Java 8 is not the default java version (you can check by executing java -version in a console), you can set the command via matcherSeals.setJavaCommand("/your/path/java1.8/bin/java"). Starting from MELT version 3.1 the Java version is checked automatically before the the SEALS client is started (it throws an exception if another version than Java 8 is used).

Prerequisites: Java 8 (not necessarily as system Java distribution), successful installation of SEALS, maven project with dependency matching-eval.

If you merely want to evaluate SEALS packages, you can use ExecutorSeals (alternatively to MatcherSeals) . You may have to give execution rights to the SEALS jar (chmod +x seals-omt-client.jar).

Example

import de.uni_mannheim.informatik.dws.melt.matching_data.TrackRepository;
import de.uni_mannheim.informatik.dws.melt.matching_eval.ExecutorSeals;
import de.uni_mannheim.informatik.dws.melt.matching_eval.evaluator.EvaluatorCSV;

public class SealsPlayground {
    public static void main(String[] args) {
        String sealsClientJar = "<path to SEALS jar>";
        String sealsHome = "<path to SEALS home directory>";
        
        // the SEALS client requires java 8
        String java8command = "<java 8 command>";
    
        // you do not have to unzip (but you can)
        String pathToSealsPackage = "<zipped or unzipped seals package>";
        
        // just one of many constructors:
        ExecutorSeals es = new ExecutorSeals(java8command, sealsClientJar, sealsHome);
        
        // using default evaluation capabilities
        EvaluatorCSV evaluatorCSV = new EvaluatorCSV(es.run(TrackRepository.Anatomy.Default, pathToSealsPackage));
        evaluatorCSV.writeToDirectory();
    }
}