org.apache.mahout.avro.text.mapred.WikipediaToAvroDocuments.java Source code

Java tutorial

Introduction

Here is the source code for org.apache.mahout.avro.text.mapred.WikipediaToAvroDocuments.java

Source

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.mahout.avro.text.mapred;

import java.io.File;
import java.io.IOException;
import java.util.HashSet;
import java.util.Set;

import org.apache.commons.cli2.CommandLine;
import org.apache.commons.cli2.Group;
import org.apache.commons.cli2.Option;
import org.apache.commons.cli2.OptionException;
import org.apache.commons.cli2.builder.ArgumentBuilder;
import org.apache.commons.cli2.builder.DefaultOptionBuilder;
import org.apache.commons.cli2.builder.GroupBuilder;
import org.apache.commons.cli2.commandline.Parser;
import org.apache.hadoop.conf.Configured;
import org.apache.hadoop.fs.FileSystem;
import org.apache.hadoop.fs.Path;
import org.apache.hadoop.io.DefaultStringifier;
import org.apache.hadoop.io.Text;
import org.apache.hadoop.mapred.FileInputFormat;
import org.apache.hadoop.mapred.FileOutputFormat;
import org.apache.hadoop.mapred.JobClient;
import org.apache.hadoop.mapred.JobConf;
import org.apache.hadoop.mapred.RunningJob;
import org.apache.hadoop.mapred.lib.IdentityReducer;
import org.apache.hadoop.util.GenericsUtil;
import org.apache.hadoop.util.Tool;
import org.apache.hadoop.util.ToolRunner;
import org.apache.mahout.avro.document.AvroDocument;
import org.apache.mahout.classifier.bayes.XmlInputFormat;
import org.apache.mahout.common.CommandLineUtil;
import org.apache.mahout.common.FileLineIterable;
import org.apache.mahout.hadoop.mapred.AvroOutputFormat;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Create and run the Wikipedia Dataset Creator.
 */
public final class WikipediaToAvroDocuments extends Configured implements Tool {
    private static final Logger log = LoggerFactory.getLogger(WikipediaToAvroDocuments.class);

    private WikipediaToAvroDocuments() {
    }

    public static void main(String[] args) throws Exception {
        ToolRunner.run(new WikipediaToAvroDocuments(), args);
    }

    /**
     * Takes in two arguments:
     * <ol>
     * <li>The input {@link org.apache.hadoop.fs.Path} where the input documents
     * live</li>
     * <li>The output {@link org.apache.hadoop.fs.Path} where to write the
     * classifier as a {@link org.apache.hadoop.io.SequenceFile}</li>
     * </ol>
     * 
     * @param args
     *          The args
     */
    public int run(String[] args) throws IOException {
        DefaultOptionBuilder obuilder = new DefaultOptionBuilder();
        ArgumentBuilder abuilder = new ArgumentBuilder();
        GroupBuilder gbuilder = new GroupBuilder();

        Option dirInputPathOpt = obuilder.withLongName("input").withRequired(true)
                .withArgument(abuilder.withName("input").withMinimum(1).withMaximum(1).create())
                .withDescription("The input directory path").withShortName("i").create();

        Option dirOutputPathOpt = obuilder.withLongName("output").withRequired(true)
                .withArgument(abuilder.withName("output").withMinimum(1).withMaximum(1).create())
                .withDescription("The output directory Path").withShortName("o").create();

        Option categoriesOpt = obuilder.withLongName("categories")
                .withArgument(abuilder.withName("categories").withMinimum(1).withMaximum(1).create())
                .withDescription("Location of the categories file.  One entry per line. "
                        + "Will be used to make a string match in Wikipedia Category field")
                .withShortName("c").create();

        Option exactMatchOpt = obuilder.withLongName("exactMatch")
                .withDescription("If set, then the category name must exactly match the "
                        + "entry in the categories file. Default is false")
                .withShortName("e").create();

        Option allOpt = obuilder.withLongName("all").withDescription("If set, Select all files. Default is false")
                .withShortName("all").create();

        Option helpOpt = obuilder.withLongName("help").withDescription("Print out help").withShortName("h")
                .create();

        Group group = gbuilder.withName("Options").withOption(categoriesOpt).withOption(dirInputPathOpt)
                .withOption(dirOutputPathOpt).withOption(exactMatchOpt).withOption(allOpt).withOption(helpOpt)
                .create();

        Parser parser = new Parser();
        parser.setGroup(group);
        try {
            CommandLine cmdLine = parser.parse(args);
            if (cmdLine.hasOption(helpOpt)) {
                CommandLineUtil.printHelp(group);
                return 0;
            }

            String inputPath = (String) cmdLine.getValue(dirInputPathOpt);
            String outputPath = (String) cmdLine.getValue(dirOutputPathOpt);

            String catFile = "";
            if (cmdLine.hasOption(categoriesOpt)) {
                catFile = (String) cmdLine.getValue(categoriesOpt);
            }

            boolean all = false;
            if (cmdLine.hasOption(allOpt)) {
                all = true;
            }
            runJob(inputPath, outputPath, catFile, cmdLine.hasOption(exactMatchOpt), all);
        } catch (OptionException e) {
            log.error("Exception", e);
            CommandLineUtil.printHelp(group);
            return 0;
        }

        return 1;
    }

    /**
     * Run the job
     * 
     * @param input
     *          the input pathname String
     * @param output
     *          the output pathname String
     * @param catFile
     *          the file containing the Wikipedia categories
     * @param exactMatchOnly
     *          if true, then the Wikipedia category must match exactly instead of
     *          simply containing the category string
     * @param all
     *          if true select all categories
     */
    public static int runJob(String input, String output, String catFile, boolean exactMatchOnly, boolean all)
            throws IOException {
        JobClient client = new JobClient();
        JobConf conf = new JobConf(WikipediaToAvroDocuments.class);
        if (log.isInfoEnabled()) {
            log.info("Input: " + input + " Out: " + output + " Categories: " + catFile + " All Files: " + all);
        }

        Path inPath = new Path(input);
        Path outPath = new Path(output);

        FileInputFormat.setInputPaths(conf, inPath);
        FileOutputFormat.setOutputPath(conf, outPath);
        //AvroOutputFormat.setClass(conf, AvroDocument.class);
        //AvroOutputFormat.setSchema(conf, AvroDocument._SCHEMA);

        conf.set("xmlinput.start", "<page>");
        conf.set("xmlinput.end", "</page>");
        conf.setOutputKeyClass(Text.class);
        conf.setOutputValueClass(AvroDocument.class);
        conf.setBoolean("exact.match.only", exactMatchOnly);
        conf.setBoolean("all.files", all);
        conf.setMapperClass(WikipediaAvroDocumentMapper.class);
        conf.setInputFormat(XmlInputFormat.class);
        conf.setReducerClass(IdentityReducer.class);
        conf.setOutputFormat(AvroOutputFormat.class);

        AvroOutputFormat.setAvroOutputClass(conf, AvroDocument.class);

        FileSystem dfs = FileSystem.get(outPath.toUri(), conf);
        if (dfs.exists(outPath)) {
            dfs.delete(outPath, true);
        }

        Set<String> categories = new HashSet<String>();
        if (catFile.equals("") == false) {
            for (String line : new FileLineIterable(new File(catFile))) {
                categories.add(line.trim().toLowerCase());
            }
        }

        DefaultStringifier<Set<String>> setStringifier = new DefaultStringifier<Set<String>>(conf,
                GenericsUtil.getClass(categories));

        String categoriesStr = setStringifier.toString(categories);

        conf.set("wikipedia.categories", categoriesStr);

        client.setConf(conf);
        RunningJob job = JobClient.runJob(conf);
        job.waitForCompletion();
        return job.isSuccessful() ? 1 : 0;
    }
}