Package de.uni_mannheim.informatik.dws.melt.matching_data

Class LocalTrack

java.lang.Object

de.uni_mannheim.informatik.dws.melt.matching_data.Track

de.uni_mannheim.informatik.dws.melt.matching_data.LocalTrack

All Implemented Interfaces:

Comparable<Track>

public class LocalTrack
extends Track

A track that does not exist on the SEALS repository. use this class if you want to create and evaluate you own data set.

Author:

Jan Portisch, Sven Hertling

Field Summary

Fields

Modifier and Type	Field	Description
private final File	folderToTestCases	Folder holding the individual test cases of the track.
private static final org.slf4j.Logger	LOGGER	Default logger.

Fields inherited from class de.uni_mannheim.informatik.dws.melt.matching_data.Track

cacheFolder, goldStandardCompleteness, name, remoteLocation, skipTestsWithoutRefAlign, testCases, useDuplicateFreeStorageLayout, version

Constructor Summary

Constructors

Constructor	Description
LocalTrack(String name, String version)	TestCases needs to be added after generating this track (when using this constructor).
LocalTrack(String name, String version, GoldStandardCompleteness goldStandardCompleteness)	TestCases needs to be added after generating this track (when using this constructor).
LocalTrack(String name, String version, File folderToTestCases)	Default Constructor with complete gold standard.
LocalTrack(String name, String version, File folderToTestCases, GoldStandardCompleteness goldStandardCompleteness)	Default Constructor
LocalTrack(String name, String version, String folderToTestCasesPath)	Convenience Constructor
LocalTrack(String name, String version, String folderToTestCasesPath, GoldStandardCompleteness goldStandardCompleteness)	Default Constructor
LocalTrack(String name, String version, List<TestCase> testCases)	Default Constructor.
LocalTrack(String name, String version, List<TestCase> testCases, GoldStandardCompleteness goldStandardCompleteness)	Default Constructor

Method Summary

Modifier and Type	Method	Description
TestCase	addTestCase(TestCase tc)
TestCase	addTestCase(String name, File source, File target, File reference)
TestCase	addTestCase(String name, File source, File target, File reference, File inputAlignment, GoldStandardCompleteness goldStandardCompleteness, File parameters, File evaluationExclusionAlignment)
TestCase	addTestCase(String name, URI source, URI target, URI reference, URI inputAlignment, GoldStandardCompleteness goldStandardCompleteness, URI parameters, URI evaluationExclusionAlignment)
protected void	downloadToCache()
protected List<TestCase>	readFromCache()

Methods inherited from class de.uni_mannheim.informatik.dws.melt.matching_data.Track

compareTo, encode, equals, getCacheFolder, getDistinctOntologies, getDistinctOntologies, getDistinctOntologiesMap, getDistinctOntologiesMap, getFirstTestCase, getName, getNameAndVersionString, getNiceRemoteLocation, getRemoteLocation, getTestCase, getTestCase, getTestCases, getTestCases, getTestCases, getVersion, hashCode, readFromDuplicateFreeLayout, readFromTestCaseLayout, saveInDefaultLayout, saveInDefaultLayout, saveInDefaultLayout, saveInDuplicateFreeLayout, saveInTestCaseLayout, saveToFile, setCacheFolder, setSkipTestCasesWithoutRefAlign, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

Default logger.

folderToTestCases

private final File folderToTestCases

Folder holding the individual test cases of the track.

Constructor Details

LocalTrack

public LocalTrack(String name,
 String version,
 File folderToTestCases,
 GoldStandardCompleteness goldStandardCompleteness)

Default Constructor

Parameters:

name - Name of the track.

version - Version of the track.

folderToTestCases - The test case folder has to follow a specific structure: It contains a folder for each test case. The Folder's name will be the test case's name. In each test case folder, there has to be a file named source.rdf, target.rdf, and reference.rdf.

goldStandardCompleteness - Completeness of the gold standard.

LocalTrack

public LocalTrack(String name,
 String version,
 String folderToTestCasesPath,
 GoldStandardCompleteness goldStandardCompleteness)

Default Constructor

Parameters:

name - Name of the track.

version - Version of the track.

folderToTestCasesPath - The test case folder path. It has to follow a specific structure: It contains a folder for each test case. The Folder's name will be the test case's name. In each test case folder, there has to be a file named source.rdf, target.rdf, and reference.rdf.

goldStandardCompleteness - Completeness of the gold standard.

LocalTrack

public LocalTrack(String name,
 String version,
 File folderToTestCases)

Default Constructor with complete gold standard.

Parameters:

name - Name of the track.

version - Version of the track.

folderToTestCases - The test case folder has to follow a specific structure: It contains a folder for each test case. the Folder's name will be the test case's name. In each test case folder, there has to be a file named source.rdf, target.rdf, and alignment.rdf.

LocalTrack

public LocalTrack(String name,
 String version,
 String folderToTestCasesPath)

Convenience Constructor

Parameters:

name - Name of the track.

version - Version of the track.

folderToTestCasesPath - The test case folder has to follow a specific structure: It contains a folder for each test case. The folder's name will be the test case's name. In each test case folder, there has to be a file named source.rdf, target.rdf, and reference.rdf.

LocalTrack

public LocalTrack(String name,
 String version,
 List<TestCase> testCases,
 GoldStandardCompleteness goldStandardCompleteness)

Default Constructor

Parameters:

name - Name of the track. Can be any text identifying the track

version - Version of the track. Can be any text identifying the version e.g. semantic versioning like 1.0.1.

testCases - the testcases corresponding to this track. The track in the testcases can be set to null (will be set in this constructor).

goldStandardCompleteness - how complete is the gold standard for this track.

LocalTrack

public LocalTrack(String name,
 String version,
 List<TestCase> testCases)

Default Constructor. The gold standard is assumed to be complete use LocalTrack(java.lang.String, java.lang.String, java.util.List, de.uni_mannheim.informatik.dws.melt.matching_data.GoldStandardCompleteness) in case it is different.

Parameters:

name - Name of the track. Can be any text identifying the track

version - Version of the track. Can be any text identifying the version e.g. semantic versioning like 1.0.1.

testCases - the testcases corresponding to this track. The track in the testcases can be set to null (will be set in this constructor).

LocalTrack

public LocalTrack(String name,
 String version,
 GoldStandardCompleteness goldStandardCompleteness)

TestCases needs to be added after generating this track (when using this constructor).

Parameters:

name - Name of the track. Can be any text identifying the track

version - Version of the track. Can be any text identifying the version e.g. semantic versioning like 1.0.1.

goldStandardCompleteness - how complete is the gold standard for this track.

LocalTrack

public LocalTrack(String name,
 String version)

TestCases needs to be added after generating this track (when using this constructor). A complete gold standard is assumed.

Parameters:

name - Name of the track. Can be any text identifying the track

version - Version of the track. Can be any text identifying the version e.g. semantic versioning like 1.0.1.

Method Details

addTestCase

public TestCase addTestCase(TestCase tc)

addTestCase

public TestCase addTestCase(String name,
 URI source,
 URI target,
 URI reference,
 URI inputAlignment,
 GoldStandardCompleteness goldStandardCompleteness,
 URI parameters,
 URI evaluationExclusionAlignment)

addTestCase

public TestCase addTestCase(String name,
 File source,
 File target,
 File reference,
 File inputAlignment,
 GoldStandardCompleteness goldStandardCompleteness,
 File parameters,
 File evaluationExclusionAlignment)

addTestCase

public TestCase addTestCase(String name,
 File source,
 File target,
 File reference)

downloadToCache

protected void downloadToCache()
                        throws Exception

Specified by:

downloadToCache in class Track

Throws:

Exception

readFromCache

protected List<TestCase> readFromCache()

Overrides:

readFromCache in class Track