AbstractMeaningMatchingsSearcher.java

/**
 * This file is part of General Entity Annotator Benchmark.
 *
 * General Entity Annotator Benchmark is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * General Entity Annotator Benchmark is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with General Entity Annotator Benchmark.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.aksw.gerbil.matching.impl;

import java.util.List;
import java.util.Set;

import org.aksw.gerbil.matching.MatchingsSearcher;
import org.aksw.gerbil.transfer.nif.Meaning;
import org.aksw.gerbil.transfer.nif.MeaningEqualityChecker;

import com.carrotsearch.hppc.BitSet;

/**
 * This implementation of a {@link MatchingsSearcher} searches for a matching
 * meaning for every given expected meaning and a list of annotator results.
 * 
 * @author Michael Röder (roeder@informatik.uni-leipzig.de)
 * 
 * @param <T>
 *            is the {@link Meaning} class or one of its extensions.
 */
public abstract class AbstractMeaningMatchingsSearcher<T extends Meaning> implements MatchingsSearcher<T> {

    @Override
    public BitSet findMatchings(T expectedElement, List<T> annotatorResults, BitSet alreadyUsedResults) {
        BitSet matching = new BitSet(alreadyUsedResults.size());
        Set<String> expectedUris = expectedElement.getUris();
        Set<String> annotatorUris = null;
        boolean expectingKBUri, annotatorHasKBUri;

        // Check whether a link to a known KB is expected
        expectingKBUri = hasKbUri(expectedElement);

        T annotatorResult;
        for (int i = 0; i < annotatorResults.size(); ++i) {
            if (!alreadyUsedResults.get(i)) {
                annotatorResult = annotatorResults.get(i);
                // extend the annotator result, if possible
                annotatorUris = annotatorResult.getUris();
                annotatorHasKBUri = hasKbUri(annotatorResult);
                // if both can be mapped to a KB
                if ((annotatorHasKBUri) && (expectingKBUri)) {
                    // if the sets are intersecting
                    if (MeaningEqualityChecker.overlaps(expectedUris, annotatorUris)) {
                        matching.set(i);
                    }
                    // else if both are not mapped to a KB
                } else if ((!annotatorHasKBUri) && (!expectingKBUri)) {
                    matching.set(i);
                }
            }
        }
        return matching;
    }

    protected abstract boolean hasKbUri(T meaning);
}