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.text.nlp.sentiment.BillMPQASentiment;
043import org.openimaj.text.nlp.sentiment.SentimentExtractor;
044import org.openimaj.twitter.USMFStatus;
045
046/**
047 *
048 * @author bill
049 */
050public class SentimentExtractionMode extends TwitterPreprocessingMode<Map<String, Object>> {
051
052    private TwitterPreprocessingMode<Map<String, List<String>>> tokMode;
053        private SentimentExtractor mpqaTokenList;
054
055    public SentimentExtractionMode() throws IOException {
056        try {
057            tokMode = new TokeniseMode();
058            this.mpqaTokenList = new BillMPQASentiment();
059        }
060        catch (Exception e) {
061            throw new IOException("Couldn't create required language detector and tokeniser", e);
062        }
063    }
064    @Override
065    //public Map<String, Object> process(USMFStatus twitterStatus) {
066    //    throw new UnsupportedOperationException("fuck");
067    //}
068    public Map<String, Object> process(USMFStatus twitterStatus) {
069        try {
070            Map<String, List<String>> a = TwitterPreprocessingMode.results(twitterStatus, tokMode);
071            if(a == null) return null;
072            List<String> strings = a.get(TokeniseMode.TOKENS_ALL);
073            if(strings == null) return null;
074                        Map<String, Object> sentiment = this.mpqaTokenList.extract(strings);
075                        twitterStatus.addAnalysis(getAnalysisKey(), sentiment);
076                        return sentiment;
077            
078        } catch (Exception ex) {
079            Logger.getLogger(SentimentExtractionMode.class.getName()).log(Level.SEVERE, null, ex);
080        }
081        return null;
082    }
083
084    @Override
085    public String getAnalysisKey() {
086        return "sentiment";
087    }
088}