001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.hadoop.tools.twitter.token.mode.match;
031
032import java.util.List;
033
034import org.apache.hadoop.io.LongWritable;
035import org.apache.hadoop.io.NullWritable;
036import org.apache.hadoop.io.Text;
037import org.apache.hadoop.mapreduce.Job;
038import org.apache.hadoop.mapreduce.Mapper;
039import org.openimaj.hadoop.mapreduce.stage.Stage;
040import org.openimaj.hadoop.mapreduce.stage.helper.TextStage;
041import org.openimaj.hadoop.tools.twitter.HadoopTwitterTokenToolOptions;
042
043/**
044 * If tokens in set of terms spit out the whole line, otherwise ignore.
045 * 
046 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
047 *
048 */
049public class TokenRegexStage extends TextStage {
050
051        /**
052         * The key where regexs are stored
053         */
054        public static final String REGEX_KEY = "org.openimaj.hadoop.tools.twitter.token.mode.match.regex";
055        /**
056         * The output folder name used returned by {@link Stage#outname()}
057         */
058        public static final String OUT_NAME = "tokenmatch";
059
060        private List<String> tomatch;
061        private String[] args;
062
063        @Override
064        public void setup(Job job) {
065                job.getConfiguration().setStrings(REGEX_KEY, tomatch.toArray(new String[tomatch.size()]));
066                job.getConfiguration().setStrings(HadoopTwitterTokenToolOptions.ARGS_KEY, this.args);
067        }
068
069        /**
070         * @param rstrings
071         *            the list of regexes to match
072         * @param args
073         *            the arguments sent to the tool
074         */
075        public TokenRegexStage(List<String> rstrings, String[] args) {
076                this.tomatch = rstrings;
077                this.args = args;
078        }
079
080        @Override
081        public Class<? extends Mapper<LongWritable, Text, NullWritable, Text>> mapper() {
082                return TokenRegexMapper.class;
083        }
084
085        @Override
086        public String outname() {
087                return OUT_NAME;
088        }
089
090}