001/**
002 * Copyright (c) 2012, 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.tools.twitter.modes.filter;
031
032import org.kohsuke.args4j.CmdLineOptionsProvider;
033
034/**
035 * The mode of the twitter processing tool
036 *
037 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
038 *
039 */
040public enum TwitterPreprocessingFilterOption implements CmdLineOptionsProvider {
041        /**
042         * geo location filtering (supports both geographic shapes or circles)
043         */
044        GEO {
045                @Override
046                public TwitterPreprocessingPredicate getOptions() {
047                        return new GeoFilter();
048                }
049        },
050        /**
051         * geo location filtering (supports both geographic shapes or circles)
052         */
053        LANG {
054                @Override
055                public TwitterPreprocessingPredicate getOptions() {
056                        return new LanguageFilter();
057                }
058        },
059        /**
060         * string match and regex match
061         */
062        GREP {
063                @Override
064                public TwitterPreprocessingPredicate getOptions() {
065                        return new GrepFilter();
066                }
067        },
068        /**
069         * A date filter
070         */
071        DATE {
072                @Override
073                public TwitterPreprocessingPredicate getOptions() {
074                        return new DateFilter();
075                }
076        },
077        /**
078         * a random filter
079         */
080        RANDOM {
081                @Override
082                public TwitterPreprocessingPredicate getOptions() {
083                        return new RandomFilter();
084                }
085        },
086        /**
087         * a random filter
088         */
089        IN_REPLY_TO{
090                @Override
091                public TwitterPreprocessingPredicate getOptions() {
092                        return new IsReplyFilter();
093                }
094        }
095
096        ;
097
098        /**
099         * @return An instance (initialising any heavyweight analysis objects) of the mode
100         */
101        @Override
102        public abstract TwitterPreprocessingPredicate getOptions() ;
103
104}
105