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.dfidf;
031
032import org.apache.hadoop.fs.Path;
033import org.kohsuke.args4j.Option;
034import org.openimaj.hadoop.mapreduce.MultiStagedJob;
035import org.openimaj.hadoop.tools.HadoopToolsUtil;
036import org.openimaj.hadoop.tools.twitter.HadoopTwitterTokenToolOptions;
037import org.openimaj.hadoop.tools.twitter.token.mode.TwitterTokenMode;
038
039/**
040 * Perform DFIDF and output such that each timeslot is a instance and each word
041 * a feature
042 * 
043 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
044 * 
045 */
046public class DFIDFTokenMode implements TwitterTokenMode {
047
048        @Option(name = "--time-delta", aliases = "-t", required = false, usage = "The length of a time window in minutes (defaults to 1 hour (60))", metaVar = "STRING")
049        private long timeDelta = 60;
050
051        private boolean combiningReducers = false;
052        private MultiStagedJob stages;
053        private String[] fstage;
054
055        @Override
056        public void perform(final HadoopTwitterTokenToolOptions opts) throws Exception {
057                Path outpath = HadoopToolsUtil.getOutputPath(opts);
058                this.stages = new MultiStagedJob(HadoopToolsUtil.getInputPaths(opts), outpath, opts.getArgs());
059
060                // Associate words with time periods and construct the time index
061                stages.queueStage(new CountTweetsInTimeperiod(opts.getNonHadoopArgs(), combiningReducers, timeDelta).stage());
062                // produce the DFIDF per word per time period
063                stages.queueStage(new CountWordsAcrossTimeperiod(opts.getNonHadoopArgs(), combiningReducers).stage());
064
065                stages.runAll();
066                this.fstage = new String[] { outpath.toString() };
067        }
068
069        @Override
070        public String[] finalOutput(HadoopTwitterTokenToolOptions opts) throws Exception {
071                return this.fstage;
072        }
073
074}