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
032import java.util.HashMap;
033import java.util.List;
034import java.util.Map;
035
036import org.openimaj.ml.annotation.AbstractAnnotator;
037
038/**
039 * An entity annotator (given a list of strings) assigns entity annotations
040 * which are {@link Map} instances mapping token indexes to entities.
041 *
042 * @author Laurence Willmore (lgw1e10@ecs.soton.ac.uk)
043 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
044 *
045 */
046public abstract class EntityAnnotator
047extends
048AbstractAnnotator<List<String>, HashMap<String, Object>>
049{
050
051        /**
052         * The types of entities which can be annotated
053         *
054         * @author Laurence Willmore (lgw1e10@ecs.soton.ac.uk)
055         * @author Sina Samangooei (ss@ecs.soton.ac.uk)
056         *
057         */
058        public enum EntityType {
059                /**
060                 * An organisation
061                 */
062                Organisation
063        }
064
065        static String URIS = "URIS";
066        static String START_TOKEN = "START";
067        static String END_TOKEN = "END";
068        static String TYPE = "TYPE";
069        static String URI = "URI";
070        static String SCORE = "SCORE";
071
072        /**
073         * Default entity annotator
074         */
075        public EntityAnnotator() {
076        }
077}