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.output;
031
032import java.io.IOException;
033import java.io.PrintWriter;
034import java.util.ArrayList;
035import java.util.List;
036
037import org.kohsuke.args4j.Option;
038import org.openimaj.tools.InOutToolOptions;
039import org.openimaj.tools.twitter.options.AbstractTwitterPreprocessingToolOptions;
040import org.openimaj.twitter.GeneralJSON;
041
042/**
043 * An ouput mode which alters the tweets being outputted
044 * 
045 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
046 *
047 */
048public class SelectiveAnalysisTwitterOutputMode extends SelectiveAnalysisOutputMode{
049        
050        @Option(name="--twitter-extras", aliases="-te", required=false, usage="On top of the analysis, what should be saved. If none are specified id and created_at are saved.", multiValued=true)
051        private List<String> twitterExtras;
052
053        /**
054         * Non selective, output everything 
055         */
056        public SelectiveAnalysisTwitterOutputMode() {
057                super();
058                this.twitterExtras = new ArrayList<String>();
059        }
060
061        @Override
062        public void output(GeneralJSON twitterStatus, PrintWriter outputWriter) throws IOException {
063                twitterStatus.writeASCIIAnalysis(outputWriter,this.selectiveAnalysis,twitterExtras);
064                if(delim != null){
065                        outputWriter.print(this.delim);
066                }
067        }
068        
069        @Override
070        public void validate(AbstractTwitterPreprocessingToolOptions twitterPreprocessingModes) {
071                super.validate(twitterPreprocessingModes);
072                InOutToolOptions.prepareMultivaluedArgument(twitterExtras, "id","created_at");
073        }
074
075
076}
077