opennlp.tools.coref.mention.HeadFinder Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreemnets. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package opennlp.tools.coref.mention;
/**
* Interface for finding head words in noun phrases and head noun-phrases in parses.
*/
public interface HeadFinder {
/**
* Returns the child parse which contains the lexical head of the specified parse.
*
* @param parse The parse in which to find the head.
* @return The parse containing the lexical head of the specified parse. If no head is
* available or the constituent has no sub-components that are eligible heads then null is returned.
*/
public Parse getHead(Parse parse);
/**
* Returns which index the specified list of token is the head word.
*
* @param parse The parse in which to find the head index.
* @return The index of the head token.
*/
public int getHeadIndex(Parse parse);
/**
* Returns the parse bottom-most head of a Parse. If no
* head is available which is a child of p then p is returned.
*
* @param p Parse to find the head of.
* @return bottom-most head of p.
*/
public Parse getLastHead(Parse p);
/**
* Returns head token for the specified np parse.
*
* @param np The noun parse to get head from.
* @return head token parse.
*/
public Parse getHeadToken(Parse np);
}