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