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 */
030package org.openimaj.text.nlp.sentiment.model.wordlist;
031
032import java.io.File;
033import java.io.IOException;
034import java.util.ArrayList;
035import java.util.List;
036
037import org.openimaj.citation.annotation.Reference;
038import org.openimaj.citation.annotation.ReferenceType;
039import org.openimaj.feature.IdentityFeatureExtractor;
040import org.openimaj.io.IOUtils;
041import org.openimaj.ml.annotation.ScoredAnnotation;
042import org.openimaj.text.nlp.sentiment.model.TokenSentimentAnnotator;
043import org.openimaj.text.nlp.sentiment.model.wordlist.util.TFF;
044import org.openimaj.text.nlp.sentiment.model.wordlist.util.TFF.Clue;
045import org.openimaj.text.nlp.sentiment.type.BipolarSentiment;
046import org.openimaj.text.nlp.sentiment.type.TFFCountSentiment;
047
048/**
049 * An implementation of the Prior-Polarity baseline sentiment classifier described by Wilson et. al.
050 * For each word that may be associated to sentiment in english, use the prior (manually ascribed) sentiment
051 * to ascribe some form of sentiment to a phrase.
052 * 
053 * This model is loaded from tff files using {@link TFF}.
054 * 
055 * The default model is found in:
056 * 
057 * /org/openimaj/text/sentiment/mpqa/subjclueslen1polar.tff
058 * 
059 * 
060 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
061 *
062 */
063@Reference(
064        author = { "Janyce Wiebe","Theresa Wilson","Claire Cardie" }, 
065        title = "Annotating expressions of opinions and emotions in language. ", 
066        type = ReferenceType.Article, 
067        year = "2005"
068)
069public class MPQAToken extends TokenSentimentAnnotator<IdentityFeatureExtractor<String>,MPQAToken>{
070        private static final String DEFAULT_MODEL = "/org/openimaj/text/sentiment/mpqa/subjclueslen1polar.tff";
071        private TFF model;
072        
073        /**
074         * Construct the sentiment model using the default word clue TFF
075         * @throws IOException
076         */
077        public MPQAToken() throws IOException {
078                super(new IdentityFeatureExtractor<String>());
079                this.model = IOUtils.read(MPQAToken.class.getResourceAsStream(DEFAULT_MODEL), TFF.class);
080        }
081        
082        /**
083         * Construct the sentiment model using the provided tff file
084         * @param f 
085         * @throws IOException
086         */
087        public MPQAToken(File f) throws IOException {
088                super(new IdentityFeatureExtractor<String>());
089                this.model = IOUtils.read(f, TFF.class);
090        }
091        
092        /**
093         * @param mpqa used by clone
094         */
095        public MPQAToken(MPQAToken mpqa) {
096                super(new IdentityFeatureExtractor<String>());
097                this.model = mpqa.model.clone();
098        }
099
100        @Override
101        public List<ScoredAnnotation<BipolarSentiment>> annotate(String word) {
102                List<ScoredAnnotation<BipolarSentiment>> ret = new ArrayList<ScoredAnnotation<BipolarSentiment>>();
103                List<Clue> clueList = this.model.entriesMap.get(word);
104                if(clueList  == null) return ret; // This isn't a sentiment bearing word
105                
106                for (Clue clue : clueList) {
107                        ret.add(new ScoredAnnotation<BipolarSentiment>(TFFCountSentiment.bipolar(clue), 1.0f));
108                }
109                return ret;
110        }
111}