# 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
  Description
  `protected HeadRules`
  AbstractBottomUpParser.`headRules`
  The head rules for the parser.
  `protected final HeadRules`
  AbstractParserEventStream.`rules`
  Methods in opennlp.tools.parser that return HeadRules
  Modifier and Type
  Method
  Description
  `HeadRules`
  ParserModel.`getHeadRules()`
  Methods in opennlp.tools.parser with parameters of type HeadRules
  Modifier and Type
  Method
  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 `HeadRules` 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
  Modifier
  Constructor
  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)`
  Initializes a `ParserCrossValidator` instance via given parameters.
  ``
  `ParserModel(String languageCode, MaxentModel buildModel, MaxentModel checkModel, MaxentModel attachModel, POSModel parserTagger, ChunkerModel chunkerTagger, HeadRules headRules, ParserType modelType)`
  Initializes a `ParserModel` instance via given parameters.
  ``
  `ParserModel(String languageCode, MaxentModel buildModel, MaxentModel checkModel, MaxentModel attachModel, POSModel parserTagger, ChunkerModel chunkerTagger, HeadRules headRules, ParserType modelType, Map<String,String> manifestInfoEntries)`
  Initializes a `ParserModel` instance via given parameters.
  ``
  `ParserModel(String languageCode, MaxentModel buildModel, MaxentModel checkModel, POSModel parserTagger, ChunkerModel chunkerTagger, HeadRules headRules, ParserType type, Map<String,String> manifestInfoEntries)`
  Initializes a `ParserModel` instance via given parameters.

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

  Methods in opennlp.tools.parser.chunking with parameters of type HeadRules
  Modifier and Type
  Method
  Description
  `static ParserModel`
  Parser.`train(String languageCode, ObjectStream<Parse> parseSamples, HeadRules rules, TrainingParameters mlParams)`
  Starts a training of a `ParserModel`.
  Constructors in opennlp.tools.parser.chunking with parameters of type HeadRules
  Modifier
  Constructor
  Description
  ``
  `ParserEventStream(ObjectStream<Parse> d, HeadRules rules, ParserEventTypeEnum etype)`
  Instantiates a `ParserEventStream` based on the specified data stream of the `type` using `head rules`.
  ``
  `ParserEventStream(ObjectStream<Parse> d, HeadRules rules, ParserEventTypeEnum etype, Dictionary dict)`
  Instantiates a `ParserEventStream` based on the specified data stream of the `type` using `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
  Description
  `class`
  `HeadRules`
  Class for storing the English `HeadRules` 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
  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
  Description
  `static ParserModel`
  Parser.`train(String languageCode, ObjectStream<Parse> parseSamples, HeadRules rules, int iterations, int cutoff)`
  Starts a training of a `ParserModel`.
  `static ParserModel`
  Parser.`train(String languageCode, ObjectStream<Parse> parseSamples, HeadRules rules, TrainingParameters mlParams)`
  Starts a training of a `ParserModel`.
  Constructors in opennlp.tools.parser.treeinsert with parameters of type HeadRules
  Modifier
  Constructor
  Description
  ``
  `ParserEventStream(ObjectStream<Parse> d, HeadRules rules, ParserEventTypeEnum etype)`
  Instantiates a `ParserEventStream` based on the specified data stream of the `type` using `head rules`.
  ``
  `ParserEventStream(ObjectStream<Parse> d, HeadRules rules, ParserEventTypeEnum etype, Dictionary dict)`
  Instantiates a `ParserEventStream` based on the specified data stream of the `type` using `head rules`.