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;
031
032
033import org.kohsuke.args4j.CmdLineOptionsProvider;
034import org.openimaj.hadoop.tools.twitter.HadoopTwitterTokenToolOptions;
035import org.openimaj.hadoop.tools.twitter.token.mode.dfidf.DFIDFTokenMode;
036import org.openimaj.hadoop.tools.twitter.token.mode.match.TokenMatchMode;
037import org.openimaj.hadoop.tools.twitter.token.mode.pointwisemi.PairwiseMutualInformationMode;
038
039/**
040 * A twitter tweet token counting mode
041 * 
042 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
043 *
044 */
045public enum TwitterTokenModeOption implements CmdLineOptionsProvider {
046        /**
047         * Calculates DF-IDF for each term as described by: "Event Detection in Twitter" by J. Weng et. al. 
048         */
049        DFIDF {
050                @Override
051                public TwitterTokenMode getOptions() {
052                        return new DFIDFTokenMode();
053                }
054        },
055        /**
056         * Calculates DF-IDF for each term as described by: "Event Detection in Twitter" by J. Weng et. al. 
057         */
058        PAIRMI{
059                @Override
060                public TwitterTokenMode getOptions() {
061                        return new PairwiseMutualInformationMode();
062                }
063        },
064        /**
065         * In the JSONPath requested locate tweets with terms which contain any of the tokens requested. The tokens may be regex
066         */
067        MATCH_TERM {
068                @Override
069                public TwitterTokenMode getOptions() {
070                        return new TokenMatchMode();
071                }
072        },
073        /**
074         * Skip the actual processing, assume the input contains the data needed by the output
075         */
076        JUST_OUTPUT {
077                @Override
078                public TwitterTokenMode getOptions()  {
079                        return new TwitterTokenMode(){
080                                private String[] finalOutput;
081
082                                @Override
083                                public void perform(HadoopTwitterTokenToolOptions opts) throws Exception {
084                                        this.finalOutput = opts.getAllInputs();
085                                }
086
087                                @Override
088                                public String[] finalOutput(HadoopTwitterTokenToolOptions opts) throws Exception {
089                                        return finalOutput;
090                                }                               
091                        };
092                }
093        }
094        ;
095        
096        @Override
097        public abstract TwitterTokenMode getOptions();
098}