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.annotations;
031
032import java.util.ArrayList;
033import java.util.Collection;
034import java.util.HashMap;
035import java.util.List;
036import java.util.Set;
037
038/**
039 * Classes that extend {@link TextPipeAnnotation} are annotations and
040 * annotatable. Annotations are a HashMap keyed on the class of the annotation,
041 * adding a new annotation T extends {@link TextPipeAnnotation} will be added to
042 * the the list of Annotations of that class already added.
043 * 
044 * @author Laurence Willmore (lgw1e10@ecs.soton.ac.uk)
045 * 
046 */
047public abstract class TextPipeAnnotation {
048
049        private HashMap<Class<? extends TextPipeAnnotation>, List<TextPipeAnnotation>> annotations;
050
051        public TextPipeAnnotation() {
052                annotations = new HashMap<Class<? extends TextPipeAnnotation>, List<TextPipeAnnotation>>();
053        }
054
055        public <T extends TextPipeAnnotation> void addAnnotation(T annotation) {
056                if (annotations.containsKey(annotation.getClass())) {
057                        annotations.get(annotation.getClass()).add(annotation);
058                } else {
059                        final ArrayList<TextPipeAnnotation> annos = new ArrayList<TextPipeAnnotation>();
060                        annos.add(annotation);
061                        annotations.put(annotation.getClass(), annos);
062                }
063        }
064
065        public <T extends TextPipeAnnotation> void addAllAnnotations(
066                        Collection<T> annotationCollection)
067        {
068                if (annotationCollection != null && annotationCollection.size() > 0) {
069                        final Class<? extends TextPipeAnnotation> key = annotationCollection.iterator().next().getClass();
070
071                        if (annotations.containsKey(key)) {
072                                annotations.get(key).addAll(annotationCollection);
073                        } else {
074                                final ArrayList<TextPipeAnnotation> annos = new ArrayList<TextPipeAnnotation>();
075                                annos.addAll(annotationCollection);
076                                annotations.put(key, annos);
077                        }
078                }
079        }
080
081        @SuppressWarnings("unchecked")
082        public <T extends TextPipeAnnotation> List<T> getAnnotationsFor(Class<T> key) {
083                if (annotations.containsKey(key)) {
084                        return (List<T>) annotations.get(key);
085                }
086                return null;
087        }
088
089        public Set<Class<? extends TextPipeAnnotation>> getAnnotationKeyList() {
090                return annotations.keySet();
091        }
092
093}