AbstractDatasetConfiguration.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.dataset;

import org.aksw.gerbil.dataset.check.EntityCheckerManager;
import org.aksw.gerbil.datatypes.AbstractAdapterConfiguration;
import org.aksw.gerbil.datatypes.ErrorTypes;
import org.aksw.gerbil.datatypes.ExperimentType;
import org.aksw.gerbil.exceptions.GerbilException;
import org.aksw.gerbil.semantic.sameas.SameAsRetriever;
import org.aksw.gerbil.semantic.sameas.SameAsRetrieverUtils;
import org.aksw.gerbil.semantic.sameas.impl.MultipleSameAsRetriever;
import org.aksw.gerbil.semantic.sameas.impl.model.DatasetBasedSameAsRetriever;
import org.aksw.gerbil.transfer.nif.Document;

public abstract class AbstractDatasetConfiguration extends AbstractAdapterConfiguration
        implements DatasetConfiguration {

    protected EntityCheckerManager entityCheckerManager;
    protected SameAsRetriever globalRetriever;

    public AbstractDatasetConfiguration(String datasetName, boolean couldBeCached,
            ExperimentType applicableForExperiment, EntityCheckerManager entityCheckerManager,
            SameAsRetriever globalRetriever) {
        super(datasetName, couldBeCached, applicableForExperiment);
        this.entityCheckerManager = entityCheckerManager;
        this.globalRetriever = globalRetriever;
    }

    @Override
    public Dataset getDataset(ExperimentType experimentType) throws GerbilException {
        // for (int i = 0; i < applicableForExperiments.length; ++i) {
        // if (applicableForExperiments[i].equalsOrContainsType(experimentType))
        if (applicableForExperiment.equalsOrContainsType(experimentType)) {
            try {
                return getPreparedDataset();
            } catch (Exception e) {
                throw new GerbilException(e, ErrorTypes.DATASET_LOADING_ERROR);
            }
        }
        return null;
    }

    protected Dataset getPreparedDataset() throws Exception {
        Dataset instance = loadDataset();
        // If this dataset should be initialized
        if (instance instanceof InitializableDataset) {
            ((InitializableDataset) instance).init();
        }
        // Expand and check the URIs of the dataset
        SameAsRetriever retriever = DatasetBasedSameAsRetriever.create(instance);
        if (retriever != null) {
            if (globalRetriever != null) {
                retriever = new MultipleSameAsRetriever(retriever, globalRetriever);
            }
        } else {
            retriever = globalRetriever;
        }
        for (Document document : instance.getInstances()) {
            if (retriever != null) {
                SameAsRetrieverUtils.addSameURIsToMarkings(retriever, document.getMarkings());
            }
            // check the meanings
            if (entityCheckerManager != null) {
                entityCheckerManager.checkMarkings(document.getMarkings());
            }
        }
        return instance;
    }

    protected abstract Dataset loadDataset() throws Exception;

}