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;
031
032import java.util.Set;
033
034import org.openimaj.feature.FeatureExtractor;
035import org.openimaj.ml.annotation.AbstractAnnotator;
036import org.openimaj.text.nlp.sentiment.type.BipolarSentiment;
037
038/**
039 * A sentiment annotator which can deal with word tokens
040 * 
041 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
042 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk),
043 * 
044 * @param <CLONETYPE>
045 * @param <EXTRACTOR>
046 *            The feature extractor used to go from String to features
047 */
048public abstract class TokenSentimentAnnotator<EXTRACTOR extends FeatureExtractor<?, String>, CLONETYPE extends SentimentAnnotator<String, CLONETYPE>>
049                extends AbstractAnnotator<String, BipolarSentiment>
050                implements SentimentAnnotator<String, CLONETYPE>
051{
052        private EXTRACTOR extractor;
053
054        /**
055         * @param extractor
056         */
057        public TokenSentimentAnnotator(EXTRACTOR extractor) {
058                this.extractor = extractor;
059        }
060
061        @Override
062        public Set<BipolarSentiment> getAnnotations() {
063                return BipolarSentiment.listBipolarSentiment();
064        }
065}