Java tutorial
/* * Ivory: A Hadoop toolkit for web-scale information retrieval research * * Licensed 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 ivory.app; import ivory.core.Constants; import ivory.core.RetrievalEnvironment; import ivory.core.preprocess.BuildDictionary; import ivory.core.preprocess.BuildIntDocVectors; import ivory.core.preprocess.BuildIntDocVectorsForwardIndex; import ivory.core.preprocess.BuildTermDocVectors; import ivory.core.preprocess.BuildTermDocVectorsForwardIndex; import ivory.core.preprocess.ComputeGlobalTermStatistics; import ivory.core.tokenize.GalagoTokenizer; import ivory.core.tokenize.Tokenizer; import org.apache.commons.cli.CommandLine; import org.apache.commons.cli.CommandLineParser; import org.apache.commons.cli.GnuParser; import org.apache.commons.cli.HelpFormatter; import org.apache.commons.cli.OptionBuilder; import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; import org.apache.hadoop.conf.Configuration; import org.apache.hadoop.conf.Configured; import org.apache.hadoop.fs.FileSystem; import org.apache.hadoop.fs.Path; import org.apache.hadoop.mapreduce.InputFormat; import org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFormat; import org.apache.hadoop.util.Tool; import org.apache.hadoop.util.ToolRunner; import org.apache.log4j.Logger; import cern.colt.Arrays; import edu.umd.cloud9.collection.DocnoMapping; @SuppressWarnings("unchecked") public class PreprocessCollection extends Configured implements Tool { private static final Logger LOG = Logger.getLogger(PreprocessCollection.class); public static final String COLLECTION_PATH = "collection"; public static final String COLLECTION_NAME = "collectionName"; public static final String INDEX_PATH = "index"; public static final String INPUTFORMAT = "inputFormat"; public static final String TOKENIZER = "tokenizer"; public static final String DOCNO_MAPPING = "docnoMapping"; public static final String DOCNO_OFFSET = "docnoOffset"; public static final String MIN_DF = "minDf"; @SuppressWarnings({ "static-access" }) protected static Options createOptions() { Options options = new Options(); options.addOption(OptionBuilder.withArgName("path").hasArg().withDescription("(required) collection path") .create(COLLECTION_PATH)); options.addOption(OptionBuilder.withArgName("name").hasArg().withDescription("(required) collection name") .create(COLLECTION_NAME)); options.addOption(OptionBuilder.withArgName("path").hasArg().withDescription("(required) index path") .create(INDEX_PATH)); options.addOption(OptionBuilder.withArgName("class").hasArg() .withDescription("(required) fully-qualified DocnoMapping").create(DOCNO_MAPPING)); options.addOption(OptionBuilder.withArgName("class").hasArg() .withDescription("(optional) fully-qualified Hadoop InputFormat: SequenceFileInputFormat default") .create(INPUTFORMAT)); options.addOption(OptionBuilder.withArgName("class").hasArg() .withDescription("(optional) fully-qualified Tokenizer: GalagoTokenizer default") .create(TOKENIZER)); options.addOption( OptionBuilder.withArgName("num").hasArg().withDescription("(optional) min Df").create(MIN_DF)); options.addOption(OptionBuilder.withArgName("num").hasArg().withDescription("(optional) docno offset") .create(DOCNO_OFFSET)); return options; } /** * Runs this tool. */ @Override public int run(String[] args) throws Exception { Options options = createOptions(); CommandLine cmdline; CommandLineParser parser = new GnuParser(); try { cmdline = parser.parse(options, args); } catch (ParseException exp) { System.err.println("Error parsing command line: " + exp.getMessage()); return -1; } if (!cmdline.hasOption(COLLECTION_PATH) || !cmdline.hasOption(COLLECTION_NAME) || !cmdline.hasOption(INDEX_PATH) || !cmdline.hasOption(DOCNO_MAPPING)) { System.out.println("args: " + Arrays.toString(args)); HelpFormatter formatter = new HelpFormatter(); formatter.setWidth(120); formatter.printHelp(this.getClass().getName(), options); ToolRunner.printGenericCommandUsage(System.out); return -1; } String collection = cmdline.getOptionValue(COLLECTION_PATH); String collectionName = cmdline.getOptionValue(COLLECTION_NAME); String indexPath = cmdline.getOptionValue(INDEX_PATH); int docnoOffset = 0; if (cmdline.hasOption(DOCNO_OFFSET)) { docnoOffset = Integer.parseInt(cmdline.getOptionValue(DOCNO_OFFSET)); } Class<? extends DocnoMapping> docnoMappingClass = null; try { docnoMappingClass = (Class<? extends DocnoMapping>) Class .forName(cmdline.getOptionValue(DOCNO_MAPPING)); } catch (ClassNotFoundException e) { throw new RuntimeException(e); } @SuppressWarnings("rawtypes") Class<? extends InputFormat> inputFormatClass = SequenceFileInputFormat.class; if (cmdline.hasOption(INPUTFORMAT)) { try { inputFormatClass = (Class<? extends InputFormat<?, ?>>) Class .forName(cmdline.getOptionValue(INPUTFORMAT)); } catch (ClassNotFoundException e) { throw new RuntimeException(e); } } Class<? extends Tokenizer> tokenizerClass = GalagoTokenizer.class; if (cmdline.hasOption(TOKENIZER)) { try { tokenizerClass = (Class<? extends Tokenizer>) Class.forName(cmdline.getOptionValue(TOKENIZER)); } catch (ClassNotFoundException e) { throw new RuntimeException(e); } } int minDf = 2; if (cmdline.hasOption(MIN_DF)) { minDf = Integer.parseInt(cmdline.getOptionValue(MIN_DF)); } LOG.info("Tool name: " + this.getClass().getSimpleName()); LOG.info(String.format(" -%s %s", COLLECTION_PATH, collection)); LOG.info(String.format(" -%s %s", COLLECTION_NAME, collectionName)); LOG.info(String.format(" -%s %s", INDEX_PATH, indexPath)); LOG.info(String.format(" -%s %s", DOCNO_MAPPING, docnoMappingClass.getCanonicalName())); LOG.info(String.format(" -%s %s", INPUTFORMAT, inputFormatClass.getCanonicalName())); LOG.info(String.format(" -%s %s", TOKENIZER, tokenizerClass.getCanonicalName())); LOG.info(String.format(" -%s %d", MIN_DF, minDf)); Configuration conf = getConf(); FileSystem fs = FileSystem.get(conf); // Create the index directory if it doesn't already exist. Path p = new Path(indexPath); if (!fs.exists(p)) { LOG.info("Index directory " + p + " doesn't exist, creating."); fs.mkdirs(p); } else { LOG.info("Index directory " + p + " already exists!"); return -1; } RetrievalEnvironment env = new RetrievalEnvironment(indexPath, fs); conf.set(Constants.CollectionName, collectionName); conf.set(Constants.CollectionPath, collection); conf.set(Constants.IndexPath, indexPath); conf.set(Constants.InputFormat, inputFormatClass.getCanonicalName()); conf.set(Constants.Tokenizer, tokenizerClass.getCanonicalName()); conf.set(Constants.DocnoMappingClass, docnoMappingClass.getCanonicalName()); conf.set(Constants.DocnoMappingFile, env.getDocnoMappingData().toString()); conf.setInt(Constants.DocnoOffset, docnoOffset); conf.setInt(Constants.MinDf, minDf); conf.setInt(Constants.MaxDf, Integer.MAX_VALUE); Path mappingFile = env.getDocnoMappingData(); docnoMappingClass.newInstance().getBuilder().build(new Path(collection), mappingFile, conf); new BuildTermDocVectors(conf).run(); new ComputeGlobalTermStatistics(conf).run(); new BuildDictionary(conf).run(); new BuildIntDocVectors(conf).run(); new BuildIntDocVectorsForwardIndex(conf).run(); new BuildTermDocVectorsForwardIndex(conf).run(); return 0; } public static void main(String[] args) throws Exception { ToolRunner.run(new PreprocessCollection(), args); } }