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;
034
035import org.openimaj.text.nlp.namedentity.NamedEntity;
036
037/**
038 * A Nameed Entity Annotation.
039 * 
040 * @author Laurence Willmore (lgw1e10@ecs.soton.ac.uk)
041 * 
042 */
043public class NamedEntityAnnotation extends TextPipeAnnotation {
044        /**
045         * Tokens matched by this Named Entity
046         */
047        public ArrayList<TokenAnnotation> tokensMatched;
048        /**
049         * The Named Entity.
050         */
051        public NamedEntity namedEntity;
052
053        public NamedEntityAnnotation() {
054                super();
055                tokensMatched = new ArrayList<TokenAnnotation>();
056        }
057
058        public NamedEntityAnnotation(ArrayList<TokenAnnotation> tokensMatched,
059                        NamedEntity namedEntity)
060        {
061                super();
062                this.tokensMatched = tokensMatched;
063                this.namedEntity = namedEntity;
064        }
065
066        /**
067         * Get the start char the matching substring for this Named Entity.
068         * 
069         * @return integer of start char
070         */
071        public int getStart() {
072                if (tokensMatched.size() > 0)
073                        return tokensMatched.get(0).start;
074                else
075                        return -1;
076        }
077
078        /**
079         * Get the end char the matching substring for this Named Entity.
080         * 
081         * @return integer of start char
082         */
083        public int getEnd() {
084                if (tokensMatched.size() > 0)
085                        return tokensMatched.get(tokensMatched.size() - 1).stop;
086                else
087                        return -1;
088        }
089
090        /**
091         * Set the {@link TokenAnnotation}s matched by this
092         * {@link NamedEntityAnnotation}
093         * 
094         * @param tokens
095         */
096        public void addAllTokensMatched(Collection<TokenAnnotation> tokens) {
097                tokensMatched.addAll(tokens);
098        }
099
100}