Uses of Interface opennlp.tools.parser.HeadRules (Apache OpenNLP Tools 1.9.5 API)
Date: 2026-06-18

## Uses of Interface
opennlp.tools.parser.HeadRules

- Packages that use HeadRules
  Package | Description
  --- | ---
  opennlp.tools.parser | Package containing common code for performing full syntactic parsing.
  opennlp.tools.parser.chunking | Package containing code for performing full syntactic parsing using shift/reduce-style decisions.
  opennlp.tools.parser.lang.en |
  opennlp.tools.parser.lang.es |
  opennlp.tools.parser.treeinsert | Package containing experimental code for performing full syntactic parsing using attachment decisions.

- - ### Uses of HeadRules in opennlp.tools.parser

    Fields in opennlp.tools.parser declared as HeadRules
    Modifier and Type | Field and Description
    --- | ---
    `protected HeadRules` | AbstractBottomUpParser.`headRules` The head rules for the parser.
    `protected HeadRules` | AbstractParserEventStream.`rules`

    Methods in opennlp.tools.parser that return HeadRules
    Modifier and Type | Method and Description
    --- | ---
    `HeadRules` | ParserModel.`getHeadRules()`

    Methods in opennlp.tools.parser with parameters of type HeadRules
    Modifier and Type | Method and Description
    --- | ---
    `void` | Parse.`add(Parse daughter, HeadRules rules)`
    `Parse` | Parse.`adjoin(Parse sister, HeadRules rules)` Sister adjoins this node's last child and the specified sister node and returns their new parent node.
    `Parse` | Parse.`adjoinRoot(Parse node, HeadRules rules, int parseIndex)`
    `static Dictionary` | AbstractBottomUpParser.`buildDictionary(ObjectStream<Parse> data, HeadRules rules, int cutoff)` Creates a n-gram dictionary from the specified data stream using the specified head rule and specified cut-off.
    `static Dictionary` | AbstractBottomUpParser.`buildDictionary(ObjectStream<Parse> data, HeadRules rules, TrainingParameters params)` Creates a n-gram dictionary from the specified data stream using the specified head rule and specified cut-off.
    `void` | Parse.`updateHeads(HeadRules rules)` Computes the head parses for this parse and its sub-parses and stores this information in the parse data structure.

    Constructors in opennlp.tools.parser with parameters of type HeadRules
    Constructor and Description
    `AbstractBottomUpParser(POSTagger tagger, Chunker chunker, HeadRules headRules, int beamSize, double advancePercentage)`
    `AbstractParserEventStream(ObjectStream<Parse> d, HeadRules rules, ParserEventTypeEnum etype)`
    `AbstractParserEventStream(ObjectStream<Parse> d, HeadRules rules, ParserEventTypeEnum etype, Dictionary dict)`
    `ParserCrossValidator(String languageCode, TrainingParameters params, HeadRules rules, ParserType parserType, ParserEvaluationMonitor... monitors)`
    `ParserModel(String languageCode, MaxentModel buildModel, MaxentModel checkModel, MaxentModel attachModel, POSModel parserTagger, ChunkerModel chunkerTagger, HeadRules headRules, ParserType modelType)`
    `ParserModel(String languageCode, MaxentModel buildModel, MaxentModel checkModel, MaxentModel attachModel, POSModel parserTagger, ChunkerModel chunkerTagger, HeadRules headRules, ParserType modelType, Map<String,String> manifestInfoEntries)`
    `ParserModel(String languageCode, MaxentModel buildModel, MaxentModel checkModel, POSModel parserTagger, ChunkerModel chunkerTagger, HeadRules headRules, ParserType type, Map<String,String> manifestInfoEntries)`

  - ### Uses of HeadRules in opennlp.tools.parser.chunking

    Methods in opennlp.tools.parser.chunking with parameters of type HeadRules
    Modifier and Type | Method and Description
    --- | ---
    `static ParserModel` | Parser.`train(String languageCode, ObjectStream<Parse> parseSamples, HeadRules rules, TrainingParameters mlParams)`

    Constructors in opennlp.tools.parser.chunking with parameters of type HeadRules
    Constructor and Description
    `ParserEventStream(ObjectStream<Parse> d, HeadRules rules, ParserEventTypeEnum etype)`
    `ParserEventStream(ObjectStream<Parse> d, HeadRules rules, ParserEventTypeEnum etype, Dictionary dict)` Create an event stream based on the specified data stream of the specified type using the specified head rules.

  - ### Uses of HeadRules in opennlp.tools.parser.lang.en

    Classes in opennlp.tools.parser.lang.en that implement HeadRules
    Modifier and Type | Class and Description
    --- | ---
    `class` | `HeadRules` Class for storing the English head rules associated with parsing.

  - ### Uses of HeadRules in opennlp.tools.parser.lang.es

    Classes in opennlp.tools.parser.lang.es that implement HeadRules
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AncoraSpanishHeadRules` Class for storing the Ancora Spanish head rules associated with parsing.

  - ### Uses of HeadRules in opennlp.tools.parser.treeinsert

    Methods in opennlp.tools.parser.treeinsert with parameters of type HeadRules
    Modifier and Type | Method and Description
    --- | ---
    `static ParserModel` | Parser.`train(String languageCode, ObjectStream<Parse> parseSamples, HeadRules rules, int iterations, int cut)`
    `static ParserModel` | Parser.`train(String languageCode, ObjectStream<Parse> parseSamples, HeadRules rules, TrainingParameters mlParams)`

    Constructors in opennlp.tools.parser.treeinsert with parameters of type HeadRules
    Constructor and Description
    `ParserEventStream(ObjectStream<Parse> d, HeadRules rules, ParserEventTypeEnum etype)`
    `ParserEventStream(ObjectStream<Parse> d, HeadRules rules, ParserEventTypeEnum etype, Dictionary dict)`

Copyright © 2026 The Apache Software Foundation. All rights reserved.