VaderSentimentAnnotator.java

/*******************************************************************************
 * Copyright (C) 2020 Ram Sadasiv
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/
package io.outofprintmagazine.nlp.pipeline.annotators;

import java.math.BigDecimal;
import java.util.Arrays;
import java.util.Collections;
import java.util.Set;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

import com.vader.sentiment.analyzer.SentimentAnalyzer;

import edu.stanford.nlp.ling.CoreAnnotation;
import edu.stanford.nlp.ling.CoreAnnotations;
import edu.stanford.nlp.ling.CoreLabel;
import edu.stanford.nlp.pipeline.Annotation;
import edu.stanford.nlp.pipeline.Annotator;
import edu.stanford.nlp.pipeline.CoreDocument;
import edu.stanford.nlp.pipeline.CoreSentence;
import edu.stanford.nlp.util.ArraySet;
import io.outofprintmagazine.nlp.pipeline.scorers.BigDecimalAvg;
import io.outofprintmagazine.nlp.pipeline.scorers.IScorer;
import io.outofprintmagazine.nlp.pipeline.serializers.BigDecimalSerializer;
import io.outofprintmagazine.nlp.pipeline.serializers.ISerializer;

public class VaderSentimentAnnotator extends AbstractPosAnnotator implements Annotator, IOOPAnnotator {

	private static final Logger logger = LogManager.getLogger(VaderSentimentAnnotator.class);
	
	@SuppressWarnings("unused")
	private Logger getLogger() {
		return logger;
	}
	
	public VaderSentimentAnnotator() {
		super();
		this.setScorer((IScorer)new BigDecimalAvg(this.getAnnotationClass()));
		this.setSerializer((ISerializer)new BigDecimalSerializer(this.getAnnotationClass()));
	}
	
	@Override
	public void annotate(Annotation annotation) {
		CoreDocument document = new CoreDocument(annotation);
        for (int i = 0, sz = document.sentences().size(); i < sz; i ++) {
        	CoreSentence sentence = document.sentences().get(i);
        	BigDecimal score = new BigDecimal(.5);
        	try {
	        	String text = sentence.text();
	        	SentimentAnalyzer sentimentAnalyzer = new SentimentAnalyzer(text);
				sentimentAnalyzer.analyze();
				score = new BigDecimal((sentimentAnalyzer.getPolarity().get("compound")+1)/2);
				sentence.coreMap().set(getAnnotationClass(), score);
				for (CoreLabel token : sentence.tokens()) {
					if (token.containsKey(getAnnotationClass())) {
						token.set(getAnnotationClass(), score);
					}
				}
			}
			catch (Exception e) {
				logger.error("bad vader", e);
				sentence.coreMap().set(getAnnotationClass(), score );
			}
        }
	}
	
	@Override
	public Class getAnnotationClass() {
		return io.outofprintmagazine.nlp.pipeline.OOPAnnotations.VaderSentimentAnnotation.class;
	}

	@Override
	public Set<Class<? extends CoreAnnotation>> requires() {
		return Collections.unmodifiableSet(
			new ArraySet<>(
				Arrays.asList(
					CoreAnnotations.TextAnnotation.class, 
					CoreAnnotations.TokensAnnotation.class,
					CoreAnnotations.SentencesAnnotation.class
				)
			)
		);
	}

	@Override
	public String getDescription() {
		return "com.vader.sentiment.analyzer.SentimentAnalyzer";
	}

}