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.namedentity;
031
032/**
033 * Container Class for Named Entity values
034 * 
035 * @author Laurence Willmore (lgw1e10@ecs.soton.ac.uk)
036 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
037 */
038public class NamedEntity {
039
040        /**
041         * Type of Named Entity
042         */
043        public enum Type {
044                Organisation,
045                Person,
046                Location
047        }
048
049        /**
050         * Type of Named Entity
051         */
052        public Type type;
053        /**
054         * Unique root name of entity
055         */
056        public String rootName;
057        /**
058         * The string that resulted in a match
059         */
060        public String stringMatched;
061        /**
062         * Start token of the match
063         */
064        public int startToken;
065        /**
066         * Stop token of the match
067         */
068        public int stopToken;
069        /**
070         * Start char of the match
071         */
072        public int startChar;
073        /**
074         * Stop char of the match
075         */
076        public int stopChar;
077
078        @Override
079        public String toString() {
080                return "NamedEntity [type=" + type + ", rootName=" + rootName
081                                + ", startToken=" + startToken + ", stopToken=" + stopToken
082                                + "]";
083        }
084
085        public NamedEntity() {
086
087        }
088
089        public NamedEntity(String rootName, Type type) {
090                this.rootName = rootName;
091                this.type = type;
092        }
093
094        @Override
095        public int hashCode() {
096                final int prime = 31;
097                int result = 1;
098                result = prime * result
099                                + ((rootName == null) ? 0 : rootName.hashCode());
100                return result;
101        }
102
103        @Override
104        public boolean equals(Object obj) {
105                if (this == obj)
106                        return true;
107                if (obj == null)
108                        return false;
109                if (getClass() != obj.getClass())
110                        return false;
111                final NamedEntity other = (NamedEntity) obj;
112                if (rootName == null) {
113                        if (other.rootName != null)
114                                return false;
115                } else if (!rootName.equals(other.rootName))
116                        return false;
117                return true;
118        }
119}