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
036/**
037 * Context scorers provide entities and likelihoods based on some context. Either
038 * all entities are available for selection or a subset.
039 * 
040 * @author Laurence Willmore (lgw1e10@ecs.soton.ac.uk)
041 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
042 * 
043 * @param <INPUT> 
044 * @param <ENTITY> 
045 */
046public abstract class EntityContextScorer<INPUT,ENTITY> {
047
048        /**
049         * Given a context give the likelihoods of each entity.
050         * 
051         * @param context
052         * @return the likelihood of each entity.
053         */
054        public abstract HashMap<ENTITY, Float> getScoredEntitiesFromContext(INPUT context);
055
056        /**
057         * Given the context give the likelihood of each entity limited by the
058         * entityUris list
059         * 
060         * @param entityUris
061         * @param context
062         * @return the likelihood of each entity in the list
063         */
064        public abstract Map<ENTITY, Float> getScoresForEntityList(List<String> entityUris, INPUT context);
065
066        /**
067         * @param entityUris
068         * @param context
069         * @return map of entities to scores
070         */
071        public abstract Map<NamedEntity, Float> getScoresForEntityList(
072                        List<String> entityUris, String context);
073
074}