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 org.openimaj.text.nlp.textpipe.annotations.TextPipeAnnotation;
033
034public abstract class AbstractTextPipeAnnotator<INPUT_ANNOTATION extends TextPipeAnnotation> {
035        
036        /**
037         * Annotates the given {@link TextPipeAnnotation}. The work is delegated to the abstract methods.
038         * @param annotation
039         * @throws MissingRequiredAnnotationException
040         */
041        public void  annotate(INPUT_ANNOTATION annotation) throws MissingRequiredAnnotationException{
042                checkForRequiredAnnotations(annotation);
043                performAnnotation(annotation);
044        }
045        
046        /**
047         * This is where the actual annotation needs to happen.
048         * @param annotation
049         * @throws MissingRequiredAnnotationException
050         */
051        abstract void performAnnotation(INPUT_ANNOTATION annotation) throws MissingRequiredAnnotationException;
052        
053        /**
054         * This is where any additional checks for other required annotations can be done.
055         * @param annotation
056         * @throws MissingRequiredAnnotationException
057         */
058        abstract void checkForRequiredAnnotations(INPUT_ANNOTATION annotation) throws MissingRequiredAnnotationException;
059
060}