HeadRules (Apache OpenNLP :: API 3.0.0-M4 API)
Description: declaration: package: opennlp.tools.parser, interface: HeadRules

Package opennlp.tools.parser

# Interface HeadRules

public interface HeadRules
Encoder for head rules associated with parsing.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Parse`
  `getHead(Parse[] constituents, String type)`
  Retrieves the head `constituent` for the specified constituents of given `type`.
  `Set<String>`
  `getPunctuationTags()`

- ## Method Details

  - ### getHead

    Parse getHead(Parse[] constituents, String type)
    Retrieves the head `constituent` for the specified constituents of given `type`.
    Parameters:
      `constituents` - The `constituents` which make up a constituent of the specified `type`.
      `type` - The type of a constituent which is made up of the `constituents`.
    Returns:
      The `constituent` which represents the head.

  - ### getPunctuationTags

    Set<String> getPunctuationTags()
    Returns:
      Retrieves the set of punctuation tags. Attachment decisions for these tags will not be modeled.