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 */
030/*
031 * To change this template, choose Tools | Templates
032 * and open the template in the editor.
033 */
034package org.openimaj.tools.twitter.modes.preprocessing;
035
036import java.io.IOException;
037import java.util.List;
038import java.util.Map;
039import java.util.logging.Level;
040import java.util.logging.Logger;
041
042import org.openimaj.ml.annotation.ScoredAnnotation;
043import org.openimaj.text.nlp.sentiment.BillMPQASentiment;
044import org.openimaj.text.nlp.sentiment.SentimentExtractor;
045import org.openimaj.text.nlp.sentiment.model.wordlist.MPQAToken;
046import org.openimaj.text.nlp.sentiment.model.wordlist.MPQATokenList;
047import org.openimaj.text.nlp.sentiment.type.BipolarSentiment;
048import org.openimaj.twitter.USMFStatus;
049import org.tartarus.snowball.ext.EnglishStemmer;
050
051/**
052 *
053 * @author bill
054 */
055public class SentimentExtractionMode extends TwitterPreprocessingMode<Map<String, Object>> {
056
057    private TwitterPreprocessingMode<Map<String, List<String>>> tokMode;
058        private SentimentExtractor mpqaTokenList;
059
060    public SentimentExtractionMode() throws IOException {
061        try {
062            tokMode = new TokeniseMode();
063            this.mpqaTokenList = new BillMPQASentiment();
064        }
065        catch (Exception e) {
066            throw new IOException("Couldn't create required language detector and tokeniser", e);
067        }
068    }
069    @Override
070    //public Map<String, Object> process(USMFStatus twitterStatus) {
071    //    throw new UnsupportedOperationException("fuck");
072    //}
073    public Map<String, Object> process(USMFStatus twitterStatus) {
074        try {
075            Map<String, List<String>> a = TwitterPreprocessingMode.results(twitterStatus, tokMode);
076            if(a == null) return null;
077            List<String> strings = a.get(TokeniseMode.TOKENS_ALL);
078            if(strings == null) return null;
079                        Map<String, Object> sentiment = this.mpqaTokenList.extract(strings);
080                        twitterStatus.addAnalysis(getAnalysisKey(), sentiment);
081                        return sentiment;
082            
083        } catch (Exception ex) {
084            Logger.getLogger(SentimentExtractionMode.class.getName()).log(Level.SEVERE, null, ex);
085        }
086        return null;
087    }
088
089    @Override
090    public String getAnalysisKey() {
091        return "sentiment";
092    }
093}