TitleRedirectPhraseAnalyzer.java

package org.wikibrain.phrases;

import com.typesafe.config.Config;
import org.wikibrain.conf.Configuration;
import org.wikibrain.conf.ConfigurationException;
import org.wikibrain.conf.Configurator;
import org.wikibrain.core.dao.DaoException;
import org.wikibrain.core.dao.LocalPageDao;
import org.wikibrain.core.dao.RedirectDao;
import org.wikibrain.core.lang.Language;
import org.wikibrain.core.lang.LanguageSet;
import org.wikibrain.core.lang.LocalId;
import org.wikibrain.core.model.LocalPage;
import org.wikibrain.core.model.NameSpace;
import org.wikibrain.core.model.Title;
import org.wikibrain.core.model.UniversalPage;

import java.io.IOException;
import java.util.LinkedHashMap;
import java.util.Map;

/**
 * Implements a deterministic phrase analyzer that returns either a single Wikipedia entity or nothing
 * based on titles and/or redirects.
 *
 * Notes:
 *  - only operates in the article namespace
 *
 * Created by Brent Hecht on 12/29/13.
 */
public class TitleRedirectPhraseAnalyzer implements PhraseAnalyzer {

    private final boolean useRedirects;
    private final LocalPageDao lpDao;
    private final RedirectDao redirectDao;

    public TitleRedirectPhraseAnalyzer(boolean useRedirects, LocalPageDao lpDao, RedirectDao redirectDao) {
        this.useRedirects = useRedirects;
        this.lpDao = lpDao;
        this.redirectDao = redirectDao;
    }

    @Override
    public int loadCorpus(LanguageSet langs) throws DaoException, IOException {
        // nothing to do here
        return -1;
    }

    @Override
    public LinkedHashMap<String, Float> describe(Language language, LocalPage page, int maxPhrases) throws DaoException {
        throw new UnsupportedOperationException("TitleRedirectPhraseAnalyzer is for resolving only");
    }

    //@Override
    public LinkedHashMap<String, Float> describeUniversal(Language language, UniversalPage page, int maxPhrases) {
        throw new UnsupportedOperationException("TitleRedirectPhraseAnalyzer is for resolving only");
    }

    @Override
    public LinkedHashMap<LocalId, Float> resolve(Language language, String phrase, int maxPages) throws DaoException {

        LinkedHashMap<LocalId, Float> result = new LinkedHashMap<LocalId, Float>();

        if (maxPages < 1) return result;

        int pageId = lpDao.getIdByTitle(new Title(phrase, language));
        if (pageId >= 0) {
            result.put(new LocalId(language, pageId), 1.0f);
        }
        return result;

    }

    public static class Provider extends org.wikibrain.conf.Provider<PhraseAnalyzer> {
        public Provider(Configurator configurator, Configuration config) throws ConfigurationException {
            super(configurator, config);
        }

        @Override
        public Class getType() {
            return PhraseAnalyzer.class;
        }

        @Override
        public String getPath() {
            return "phrases.analyzer";
        }

        @Override
        public PhraseAnalyzer get(String name, Config config, Map<String, String> runtimeParams) throws ConfigurationException {
            if (!config.getString("type").equals("titleRedirect")) {
                return null;
            }
            LocalPageDao lpDao = getConfigurator().get(LocalPageDao.class, config.getString("localPageDao"));
            RedirectDao redirectDao = getConfigurator().get(RedirectDao.class, config.getString("redirectDao"));
            Boolean useRedirects = Boolean.parseBoolean(config.getString("useRedirects"));
            return new TitleRedirectPhraseAnalyzer(useRedirects, lpDao, redirectDao);
        }
    }
}