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.outputmode;
031
032
033import org.kohsuke.args4j.CmdLineOptionsProvider;
034import org.openimaj.hadoop.tools.twitter.HadoopTwitterTokenToolOptions;
035import org.openimaj.hadoop.tools.twitter.token.mode.TwitterTokenMode;
036import org.openimaj.hadoop.tools.twitter.token.outputmode.correlation.CorrelationOutputMode;
037import org.openimaj.hadoop.tools.twitter.token.outputmode.jacard.JacardIndexOutputMode;
038import org.openimaj.hadoop.tools.twitter.token.outputmode.sparsecsv.SparseCSVTokenOutputMode;
039import org.openimaj.hadoop.tools.twitter.token.outputmode.stats.StatsOutputMode;
040import org.openimaj.hadoop.tools.twitter.token.outputmode.timeseries.SpecificWordTimeSeries;
041
042/**
043 * A twitter tweet token counting mode
044 * 
045 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
046 *
047 */
048public enum TwitterTokenOutputModeOption implements CmdLineOptionsProvider{
049        
050        /**
051         * outputs a CSV file  
052         */
053        CSV {
054
055                @Override
056                public TwitterTokenOutputMode getOptions() {
057                        return new SparseCSVTokenOutputMode();
058                }
059                
060        },
061        /**
062         * outputs a SPECIFIC_WORDfile  
063         */
064        SPECIFIC_WORD {
065
066                @Override
067                public TwitterTokenOutputMode getOptions() {
068                        return new SpecificWordTimeSeries();
069                }
070                
071        },
072        /**
073         * outputs the jacard index at each time step, a measure for how similar the sets of words are between two timesteps
074         */
075        JACARD_INDEX {
076
077                @Override
078                public TwitterTokenOutputMode getOptions() {
079                        return new JacardIndexOutputMode();
080                }
081                
082        },
083        /**
084         * 
085         */
086        CORRELATION{
087
088                @Override
089                public TwitterTokenOutputMode getOptions() {
090                        return new CorrelationOutputMode();
091                }
092                
093        },
094        /**
095         * Output some statistics about the words
096         */
097        WORD_STATS{
098
099                @Override
100                public TwitterTokenOutputMode getOptions() {
101                        return new StatsOutputMode();
102                }
103                
104        }, 
105        /**
106         * don't do anything
107         */
108        NONE {
109                @Override
110                public TwitterTokenOutputMode getOptions() {
111                        return new TwitterTokenOutputMode(){
112
113                                @Override
114                                public void write(HadoopTwitterTokenToolOptions opts,TwitterTokenMode completedMode) throws Exception {
115                                        // do nothing
116                                }
117                                
118                        };
119                }
120        };
121
122        @Override
123        public abstract TwitterTokenOutputMode getOptions();
124}