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.textpipe.annotators;
031
032import java.util.List;
033
034import org.openimaj.text.nlp.textpipe.annotations.AnnotationUtils;
035import org.openimaj.text.nlp.textpipe.annotations.POSAnnotation;
036import org.openimaj.text.nlp.textpipe.annotations.RawTextAnnotation;
037import org.openimaj.text.nlp.textpipe.annotations.SentenceAnnotation;
038import org.openimaj.text.nlp.textpipe.annotations.TokenAnnotation;
039
040public abstract class AbstractPOSAnnotator extends
041                AbstractTextPipeAnnotator<RawTextAnnotation> {
042
043        @Override
044        public void performAnnotation(RawTextAnnotation annotation)
045                        throws MissingRequiredAnnotationException {
046                if (annotation.getAnnotationKeyList()
047                                .contains(SentenceAnnotation.class)) {
048                        for (SentenceAnnotation sentence : annotation
049                                        .getAnnotationsFor(SentenceAnnotation.class)) {
050                                if (sentence.getAnnotationKeyList().contains(
051                                                TokenAnnotation.class)) {
052                                        List<TokenAnnotation> tokens = sentence.getAnnotationsFor(TokenAnnotation.class);
053                                        List<POSAnnotation.PartOfSpeech> postags = pos(AnnotationUtils.getStringTokensFromTokenAnnotationList(tokens));
054                                        for(int i =0; i<postags.size();i++){
055                                                tokens.get(i).addAnnotation(new POSAnnotation(postags.get(i)));
056                                        }
057                                } else
058                                        throw new MissingRequiredAnnotationException(
059                                                        "Untokenised sentence found: Require TokenAnnotations.");
060                        }
061                } else {
062                        if (annotation.getAnnotationKeyList().contains(
063                                        TokenAnnotation.class)) {
064                                List<TokenAnnotation> tokens = annotation.getAnnotationsFor(TokenAnnotation.class);
065                                List<POSAnnotation.PartOfSpeech> postags = pos(AnnotationUtils.getStringTokensFromTokenAnnotationList(tokens));
066                                for(int i =0; i<postags.size();i++){
067                                        tokens.get(i).addAnnotation(new POSAnnotation(postags.get(i)));
068                                }
069                        } else
070                                throw new MissingRequiredAnnotationException(
071                                                "No TokenAnnotations found: Require TokenAnnotations.");
072                }
073
074        }
075
076        protected abstract List<POSAnnotation.PartOfSpeech> pos(
077                        List<String> tokenList);
078
079}