info.bliki.wiki.dump.IArticleFilter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of bliki-core Show documentation

This is the core project.

The newest version!

package info.bliki.wiki.dump;

import java.io.IOException;

/**
 * Interface for a filter which processes all articles from a given wikipedia
 * XML dump file
 */
public interface IArticleFilter {
    /**
     * Process a single Wikipedia article
     *
     * @param article
     *          a Wikipedia article
     * @param siteinfo
     *          the site and namespace information found in the header of a
     *          Mediawiki dump. Maybe null
     * @throws IOException
     *           throw an IOException for stopping the processing
     */
    void process(WikiArticle article, Siteinfo siteinfo) throws IOException;
}