## Uses of Class
opennlp.tools.parser.Parse

- Packages that use Parse
  Package | Description
  --- | ---
  opennlp.tools.cmdline.parser |
  opennlp.tools.formats | Experimental package related to converting various corpora to OpenNLP Format.
  opennlp.tools.formats.convert |
  opennlp.tools.formats.frenchtreebank | Experimental package related to the French Treebank format.
  opennlp.tools.formats.ontonotes | Experimental package related to the OntoNotes 4.0 format.
  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 Parse in opennlp.tools.cmdline.parser

    Methods in opennlp.tools.cmdline.parser that return Parse
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Parse[]` | ParserTool.`parseLine​(String line, Parser parser, int numParses)` |
    `static Parse[]` | ParserTool.`parseLine​(String line, Parser parser, Tokenizer tokenizer, int numParses)` |

    Method parameters in opennlp.tools.cmdline.parser with type arguments of type Parse
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected ParserModel` | BuildModelUpdaterTool.`trainAndUpdate​(ParserModel originalModel, ObjectStream<Parse> parseSamples, opennlp.tools.cmdline.parser.ModelUpdaterTool.ModelUpdaterParams parameters)` |
    `protected ParserModel` | CheckModelUpdaterTool.`trainAndUpdate​(ParserModel originalModel, ObjectStream<Parse> parseSamples, opennlp.tools.cmdline.parser.ModelUpdaterTool.ModelUpdaterParams parameters)` |

  - ### Uses of Parse in opennlp.tools.formats

    Methods in opennlp.tools.formats that return types with arguments of type Parse
    Modifier and Type | Method | Description
    --- | --- | ---
    `ObjectStream<Parse>` | ParseSampleStreamFactory.`create​(String[] args)` |

  - ### Uses of Parse in opennlp.tools.formats.convert

    Constructor parameters in opennlp.tools.formats.convert with type arguments of type Parse
    Constructor | Description
    --- | ---
    `ParseToPOSSampleStream​(ObjectStream<Parse> samples)` | Initializes a `ParseToPOSSampleStream`.

  - ### Uses of Parse in opennlp.tools.formats.frenchtreebank

    Methods in opennlp.tools.formats.frenchtreebank that return Parse
    Modifier and Type | Method | Description
    --- | --- | ---
    `Parse` | ConstitParseSampleStream.`read()` |

    Methods in opennlp.tools.formats.frenchtreebank that return types with arguments of type Parse
    Modifier and Type | Method | Description
    --- | --- | ---
    `ObjectStream<Parse>` | ConstitParseSampleStreamFactory.`create​(String[] args)` |

  - ### Uses of Parse in opennlp.tools.formats.ontonotes

    Methods in opennlp.tools.formats.ontonotes that return Parse
    Modifier and Type | Method | Description
    --- | --- | ---
    `Parse` | OntoNotesParseSampleStream.`read()` |

    Methods in opennlp.tools.formats.ontonotes that return types with arguments of type Parse
    Modifier and Type | Method | Description
    --- | --- | ---
    `ObjectStream<Parse>` | OntoNotesParseSampleStreamFactory.`create​(String[] args)` |

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

    Methods in opennlp.tools.parser that return Parse
    Modifier and Type | Method | Description
    --- | --- | ---
    `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)` |
    `protected Parse[]` | AbstractBottomUpParser.`advanceChunks​(Parse p, double minChunkScore)` | Returns the top chunk sequences for the specified `Parse`.
    `protected abstract Parse[]` | AbstractBottomUpParser.`advanceParses​(Parse p, double probMass)` | Advances the specified `Parse` and returns the an array advanced parses whose probability accounts for more than the specified amount of probability mass.
    `protected Parse[]` | AbstractBottomUpParser.`advanceTags​(Parse p)` | Advances the `Parse` by assigning it POS tags and returns multiple tag sequences.
    `Parse` | Parse.`clone​(Parse node)` | Clones the right frontier of `Parse` up to the specified `node`.
    `Parse` | Parse.`cloneRoot​(Parse node, int parseIndex)` | Clones the right frontier of this root `Parse` up to and including the specified node.
    `static Parse[]` | AbstractBottomUpParser.`collapsePunctuation​(Parse[] chunks, Set<String> punctSet)` | Removes the punctuation from the specified set of `chunks`, adds it to the parses adjacent to the punctuation is specified, and returns a new array of parses with the punctuation removed.
    `Parse[]` | Parse.`getChildren()` |
    `Parse` | Parse.`getCommonParent​(Parse node)` | Returns the deepest shared parent of this node and the specified node.
    `Parse` | HeadRules.`getHead​(Parse[] constituents, String type)` | Retrieves the head `constituent` for the specified constituents of given `type`.
    `Parse` | Parse.`getHead()` |
    `static Parse[]` | AbstractParserEventStream.`getInitialChunks​(Parse p)` |
    `static Parse[]` | ChunkSampleStream.`getInitialChunks​(Parse p)` |
    `Parse` | Parse.`getParent()` |
    `Parse[]` | Parse.`getTagNodes()` |
    `Parse[]` | Parse.`getTokenNodes()` |
    `Parse` | AbstractBottomUpParser.`parse​(Parse tokens)` |
    `Parse[]` | AbstractBottomUpParser.`parse​(Parse tokens, int numParses)` |
    `Parse` | Parser.`parse​(Parse tokens)` | Returns a `Parse` for the specified `Parse` of `tokens`.
    `Parse[]` | Parser.`parse​(Parse tokens, int numParses)` | Returns the specified number of parses or fewer for the specified tokens.
    `static Parse` | Parse.`parseParse​(String parse)` | Parses the specified tree-bank style parse string and return a `Parse` structure for that string.
    `static Parse` | Parse.`parseParse​(String parse, GapLabeler gl)` | Parses the specified tree-bank style `Parse` string and return a `Parse` structure for that string.
    `protected Parse` | ParserEvaluator.`processSample​(Parse reference)` |
    `Parse` | ParseSampleStream.`read()` |

    Methods in opennlp.tools.parser that return types with arguments of type Parse
    Modifier and Type | Method | Description
    --- | --- | ---
    `Collection<Parse>` | Parse.`getNextPunctuationSet()` |
    `Collection<Parse>` | Parse.`getPreviousPunctuationSet()` |

    Methods in opennlp.tools.parser with parameters of type Parse
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | Parse.`add​(Parse daughter, HeadRules rules)` |
    `static void` | Parse.`addNames​(String tag, Span[] names, Parse[] tokens)` | Utility method to insert named entities.
    `void` | Parse.`addNextPunctuation​(Parse punct)` | Designates that the specified punctuation follows this parse.
    `protected abstract void` | AbstractParserEventStream.`addParseEvents​(List<Event> newEvents, Parse[] chunks)` | Produces all events for the specified sentence `chunks` and adds them to the specified `newEvents` list.
    `void` | Parse.`addPreviousPunctuation​(Parse punct)` | Designates that the specified punctuation should is prior to this parse.
    `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)` |
    `protected Parse[]` | AbstractBottomUpParser.`advanceChunks​(Parse p, double minChunkScore)` | Returns the top chunk sequences for the specified `Parse`.
    `protected abstract Parse[]` | AbstractBottomUpParser.`advanceParses​(Parse p, double probMass)` | Advances the specified `Parse` and returns the an array advanced parses whose probability accounts for more than the specified amount of probability mass.
    `protected Parse[]` | AbstractBottomUpParser.`advanceTags​(Parse p)` | Advances the `Parse` by assigning it POS tags and returns multiple tag sequences.
    `protected abstract void` | AbstractBottomUpParser.`advanceTop​(Parse p)` | Adds the `AbstractBottomUpParser.TOP_NODE` to the specified parse.
    `protected void` | AbstractContextGenerator.`checkcons​(Parse child, String i, String type, List<String> features)` | Produces features to determine whether the specified child node is part of a complete constituent of the specified type and adds those features to the specified list.
    `protected void` | AbstractContextGenerator.`checkcons​(Parse p1, Parse p2, String type, List<String> features)` |
    `Parse` | Parse.`clone​(Parse node)` | Clones the right frontier of `Parse` up to the specified `node`.
    `Parse` | Parse.`cloneRoot​(Parse node, int parseIndex)` | Clones the right frontier of this root `Parse` up to and including the specified node.
    `static Parse[]` | AbstractBottomUpParser.`collapsePunctuation​(Parse[] chunks, Set<String> punctSet)` | Removes the punctuation from the specified set of `chunks`, adds it to the parses adjacent to the punctuation is specified, and returns a new array of parses with the punctuation removed.
    `int` | Parse.`compareTo​(Parse p)` |
    `protected String` | AbstractContextGenerator.`cons​(Parse p, int i)` |
    `protected String` | AbstractContextGenerator.`consbo​(Parse p, int i)` |
    `protected Iterator<Event>` | AbstractParserEventStream.`createEvents​(Parse sample)` |
    `void` | Parse.`expandTopNode​(Parse root)` |
    `static void` | Parse.`fixPossesives​(Parse parse)` |
    `Parse` | Parse.`getCommonParent​(Parse node)` | Returns the deepest shared parent of this node and the specified node.
    `protected void` | AbstractContextGenerator.`getFrontierNodes​(List<Parse> rf, Parse[] nodes)` | Populates specified nodes array with left-most right frontier node with a unique head.
    `Parse` | HeadRules.`getHead​(Parse[] constituents, String type)` | Retrieves the head `constituent` for the specified constituents of given `type`.
    `static Parse[]` | AbstractParserEventStream.`getInitialChunks​(Parse p)` |
    `static Parse[]` | ChunkSampleStream.`getInitialChunks​(Parse p)` |
    `int` | Parse.`indexOf​(Parse child)` |
    `void` | Parse.`insert​(Parse constituent)` | Inserts the specified constituent into this parse based on its text span.
    `protected boolean` | AbstractParserEventStream.`lastChild​(Parse child, Parse parent)` | Returns `true` if the `child` is the last child of the specified `parent`.
    `protected int` | AbstractBottomUpParser.`mapParseIndex​(int index, Parse[] nonPunctParses, Parse[] parses)` | Determines the mapping between the specified `index` into the specified `parses` without punctuation to the corresponding index into the specified `parses`.
    `Parse` | AbstractBottomUpParser.`parse​(Parse tokens)` |
    `Parse[]` | AbstractBottomUpParser.`parse​(Parse tokens, int numParses)` |
    `Parse` | Parser.`parse​(Parse tokens)` | Returns a `Parse` for the specified `Parse` of `tokens`.
    `Parse[]` | Parser.`parse​(Parse tokens, int numParses)` | Returns the specified number of parses or fewer for the specified tokens.
    `protected Parse` | ParserEvaluator.`processSample​(Parse reference)` |
    `protected String` | AbstractContextGenerator.`production​(Parse p, boolean includePunctuation)` | Generates a string representing the grammar rule production that the specified parse is starting.
    `static void` | Parse.`pruneParse​(Parse parse)` | Prune the specified sentence parse of vacuous productions.
    `protected String` | AbstractContextGenerator.`punct​(Parse punct, int i)` | Creates punctuation feature for the specified punctuation at the specified index `i` based on the `punctuation` mark.
    `protected String` | AbstractContextGenerator.`punctbo​(Parse punct, int i)` | Creates punctuation feature for the specified punctuation at the specified index `i` based on the `punctuation`'s tag.
    `void` | Parse.`setParent​(Parse parent)` | Specifies the parent parse node for this constituent.
    `static void` | AbstractBottomUpParser.`setParents​(Parse p)` | Assigns parent references for the specified parse so that they are consistent with the children references.
    `protected void` | AbstractContextGenerator.`surround​(Parse node, int i, String type, Collection<Parse> punctuation, List<String> features)` | Generates features for nodes surrounding a completed node of the specified `type`.

    Method parameters in opennlp.tools.parser with type arguments of type Parse
    Modifier and Type | Method | Description
    --- | --- | ---
    `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.
    `protected void` | AbstractContextGenerator.`cons2​(List<String> features, Cons c0, Cons c1, Collection<Parse> punct1s, boolean bigram)` |
    `protected void` | AbstractContextGenerator.`cons3​(List<String> features, Cons c0, Cons c1, Cons c2, Collection<Parse> punct1s, Collection<Parse> punct2s, boolean trigram, boolean bigram1, boolean bigram2)` | Creates cons features involving the 3 specified nodes and adds them to the specified feature list.
    `void` | ParserCrossValidator.`evaluate​(ObjectStream<Parse> samples, int nFolds)` | Starts the evaluation.
    `protected void` | AbstractContextGenerator.`getFrontierNodes​(List<Parse> rf, Parse[] nodes)` | Populates specified nodes array with left-most right frontier node with a unique head.
    `void` | Parse.`setNextPunctuation​(Collection<Parse> punctSet)` | Sets the `punctuation tags` which follow this parse.
    `void` | Parse.`setPrevPunctuation​(Collection<Parse> punctSet)` | Sets the `punctuation tags` which precede this parse.
    `protected void` | AbstractContextGenerator.`surround​(Parse node, int i, String type, Collection<Parse> punctuation, List<String> features)` | Generates features for nodes surrounding a completed node of the specified `type`.

    Constructors in opennlp.tools.parser with parameters of type Parse
    Constructor | Description
    --- | ---
    `Parse​(String text, Span span, String type, double p, Parse h)` | Initializes a `node` for this specified `text` and `span` of the specified `type` with probability `p` and the head `index`.

    Constructor parameters in opennlp.tools.parser with type arguments of type Parse
    Constructor | Description
    --- | ---
    `AbstractParserEventStream​(ObjectStream<Parse> d, HeadRules rules, ParserEventTypeEnum etype)` |
    `AbstractParserEventStream​(ObjectStream<Parse> d, HeadRules rules, ParserEventTypeEnum etype, Dictionary dict)` |
    `ChunkSampleStream​(ObjectStream<Parse> in)` | Initializes a `instance`.
    `PosSampleStream​(ObjectStream<Parse> in)` | Initializes a `instance`.

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

    Methods in opennlp.tools.parser.chunking that return Parse
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected Parse[]` | Parser.`advanceParses​(Parse p, double probMass)` |
    `static Parse[]` | ParserEventStream.`reduceChunks​(Parse[] chunks, int ci, Parse parent)` |

    Methods in opennlp.tools.parser.chunking with parameters of type Parse
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected void` | ParserEventStream.`addParseEvents​(List<Event> parseEvents, Parse[] chunks)` | Adds `events` for parsing (post tagging and chunking) to the specified list of events for the specified parse chunks.
    `protected Parse[]` | Parser.`advanceParses​(Parse p, double probMass)` |
    `protected void` | Parser.`advanceTop​(Parse p)` |
    `protected boolean` | ParserEventStream.`firstChild​(Parse child, Parse parent)` |
    `String[]` | BuildContextGenerator.`getContext​(Parse[] constituents, int index)` | Finds the predictive context used to determine how constituent at the specified `index` should be combined with other constituents.
    `String[]` | CheckContextGenerator.`getContext​(Parse[] constituents, String type, int start, int end)` | Finds predictive context for deciding whether the specified constituents between the specified `start` and `end` index can be combined to form a new constituent of the specified `type`.
    `static Parse[]` | ParserEventStream.`reduceChunks​(Parse[] chunks, int ci, Parse parent)` |

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

    Constructor parameters in opennlp.tools.parser.chunking with type arguments of type Parse
    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 Parse in opennlp.tools.parser.lang.en

    Methods in opennlp.tools.parser.lang.en that return Parse
    Modifier and Type | Method | Description
    --- | --- | ---
    `Parse` | HeadRules.`getHead​(Parse[] constituents, String type)` |

    Methods in opennlp.tools.parser.lang.en with parameters of type Parse
    Modifier and Type | Method | Description
    --- | --- | ---
    `Parse` | HeadRules.`getHead​(Parse[] constituents, String type)` |

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

    Methods in opennlp.tools.parser.lang.es that return Parse
    Modifier and Type | Method | Description
    --- | --- | ---
    `Parse` | AncoraSpanishHeadRules.`getHead​(Parse[] constituents, String type)` |

    Methods in opennlp.tools.parser.lang.es with parameters of type Parse
    Modifier and Type | Method | Description
    --- | --- | ---
    `Parse` | AncoraSpanishHeadRules.`getHead​(Parse[] constituents, String type)` |

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

    Methods in opennlp.tools.parser.treeinsert that return Parse
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected Parse[]` | Parser.`advanceChunks​(Parse p, double minChunkScore)` |
    `protected Parse[]` | Parser.`advanceParses​(Parse p, double probMass)` |

    Methods in opennlp.tools.parser.treeinsert that return types with arguments of type Parse
    Modifier and Type | Method | Description
    --- | --- | ---
    `static List<Parse>` | Parser.`getRightFrontier​(Parse root, Set<String> punctSet)` | Returns the right frontier of the specified `tree` with nodes ordered from deepest to shallowest.

    Methods in opennlp.tools.parser.treeinsert with parameters of type Parse
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected void` | ParserEventStream.`addParseEvents​(List<Event> parseEvents, Parse[] chunks)` |
    `protected Parse[]` | Parser.`advanceChunks​(Parse p, double minChunkScore)` |
    `protected Parse[]` | Parser.`advanceParses​(Parse p, double probMass)` |
    `protected void` | Parser.`advanceTop​(Parse p)` |
    `String[]` | AttachContextGenerator.`getContext​(Parse[] constituents, int index, List<Parse> rightFrontier, int rfi)` | Finds the predictive contextual features about an attachment.
    `String[]` | BuildContextGenerator.`getContext​(Parse[] constituents, int index)` | Finds the contexts/features for the decision to build a new constituent for the specified parse at the specified `index`.
    `String[]` | CheckContextGenerator.`getContext​(Parse parent, Parse[] constituents, int index, boolean trimFrontier)` | Finds the predictive context used to determine how constituent at the specified `index` should be combined with a `parent` constituent.
    `static List<Parse>` | Parser.`getRightFrontier​(Parse root, Set<String> punctSet)` | Returns the right frontier of the specified `tree` with nodes ordered from deepest to shallowest.
    `protected boolean` | ParserEventStream.`lastChild​(Parse child, Parse parent)` |

    Method parameters in opennlp.tools.parser.treeinsert with type arguments of type Parse
    Modifier and Type | Method | Description
    --- | --- | ---
    `String[]` | AttachContextGenerator.`getContext​(Parse[] constituents, int index, List<Parse> rightFrontier, int rfi)` | Finds the predictive contextual features about an attachment.
    `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`.

    Constructor parameters in opennlp.tools.parser.treeinsert with type arguments of type Parse
    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`.