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 */
030/**
031# * Copyright (c) 2011, The University of Southampton and the individual contributors.
032 * All rights reserved.
033 *
034 * Redistribution and use in source and binary forms, with or without modification,
035 * are permitted provided that the following conditions are met:
036 *
037 *   *  Redistributions of source code must retain the above copyright notice,
038 *      this list of conditions and the following disclaimer.
039 *
040 *   *  Redistributions in binary form must reproduce the above copyright notice,
041 *      this list of conditions and the following disclaimer in the documentation
042 *      and/or other materials provided with the distribution.
043 *
044 *   *  Neither the name of the University of Southampton nor the names of its
045 *      contributors may be used to endorse or promote products derived from this
046 *      software without specific prior written permission.
047 *
048 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
049 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
050 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
051 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
052 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
053 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
054 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
055 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
056 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
057 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
058 */
059package org.openimaj.hadoop.tools.twitter.token.outputmode;
060
061import java.io.IOException;
062import org.kohsuke.args4j.Option;
063import org.openimaj.hadoop.tools.twitter.HadoopTwitterTokenToolOptions;
064import org.openimaj.hadoop.tools.twitter.token.mode.TwitterTokenMode;
065
066/**
067 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
068 *
069 */
070public abstract class TwitterTokenOutputMode {
071        
072        
073        @Option(name="--results-output", aliases="-ro", required=false, usage="Where should the results be outputted?", metaVar="STRING")
074        public String outputPath = null;
075        
076        @Option(name="--results-output-overwrite", aliases="-rorm", required=false, usage="Where should the results be outputted?", metaVar="STRING")
077        public boolean replace = false;
078        
079        
080        
081        /**
082         * @param opts The token tool options
083         * @param completedMode The mode to output from
084         * @param outputPath The final location of the output
085         * @param replace whether to replace an existing output
086         * @throws IOException 
087         * 
088         */
089        public abstract void write(
090                        HadoopTwitterTokenToolOptions opts, 
091                        TwitterTokenMode completedMode) throws Exception;
092
093}