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.RawTextAnnotation;
035import org.openimaj.text.nlp.textpipe.annotations.SentenceAnnotation;
036import org.openimaj.text.nlp.textpipe.annotations.TokenAnnotation;
037
038public abstract class AbstractTokenAnnotator extends
039                AbstractTextPipeAnnotator<RawTextAnnotation>{
040
041        /**
042         * {@link AbstractTokenAnnotator} will annotate the
043         * {@link RawTextAnnotation} directly with {@link TokenAnnotation} unless
044         * there is already a {@link SentenceAnnotation}. Then it will annotate each
045         * {@link SentenceAnnotation}.
046         */
047        @Override
048        public void performAnnotation(RawTextAnnotation annotation) {
049                if (annotation.getAnnotationKeyList()
050                                .contains(SentenceAnnotation.class)) {
051                        for (SentenceAnnotation sentence : annotation
052                                        .getAnnotationsFor(SentenceAnnotation.class)) {
053                                sentence.addAllAnnotations(tokenise(sentence.text));
054                        }
055                } else
056                        annotation.addAllAnnotations(tokenise(annotation.text));
057        }
058        
059        abstract List<TokenAnnotation> tokenise(String text);
060
061}