/**
 * Copyright (c) 2011, The University of Southampton and the individual contributors.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 *   * 	Redistributions of source code must retain the above copyright notice,
 * 	this list of conditions and the following disclaimer.
 *
 *   *	Redistributions in binary form must reproduce the above copyright notice,
 * 	this list of conditions and the following disclaimer in the documentation
 * 	and/or other materials provided with the distribution.
 *
 *   *	Neither the name of the University of Southampton nor the names of its
 * 	contributors may be used to endorse or promote products derived from this
 * 	software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.openimaj.hadoop.tools.twitter.token.mode.match;

import java.util.List;

import org.apache.hadoop.io.LongWritable;
import org.apache.hadoop.io.NullWritable;
import org.apache.hadoop.io.Text;
import org.apache.hadoop.mapreduce.Job;
import org.apache.hadoop.mapreduce.Mapper;
import org.openimaj.hadoop.mapreduce.stage.Stage;
import org.openimaj.hadoop.mapreduce.stage.helper.TextStage;
import org.openimaj.hadoop.tools.twitter.HadoopTwitterTokenToolOptions;

/**
 * If tokens in set of terms spit out the whole line, otherwise ignore.
 * 
 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
 *
 */
public class TokenRegexStage extends TextStage {

	/**
	 * The key where regexs are stored
	 */
	public static final String REGEX_KEY = "org.openimaj.hadoop.tools.twitter.token.mode.match.regex";
	/**
	 * The output folder name used returned by {@link Stage#outname()}
	 */
	public static final String OUT_NAME = "tokenmatch";

	private List<String> tomatch;
	private String[] args;

	@Override
	public void setup(Job job) {
		job.getConfiguration().setStrings(REGEX_KEY, tomatch.toArray(new String[tomatch.size()]));
		job.getConfiguration().setStrings(HadoopTwitterTokenToolOptions.ARGS_KEY, this.args);
	}

	/**
	 * @param rstrings
	 *            the list of regexes to match
	 * @param args
	 *            the arguments sent to the tool
	 */
	public TokenRegexStage(List<String> rstrings, String[] args) {
		this.tomatch = rstrings;
		this.args = args;
	}

	@Override
	public Class<? extends Mapper<LongWritable, Text, NullWritable, Text>> mapper() {
		return TokenRegexMapper.class;
	}

	@Override
	public String outname() {
		return OUT_NAME;
	}

}
