## Uses of Class
opennlp.tools.namefind.NameSample

- Packages that use NameSample
  Package | Description
  --- | ---
  opennlp.tools.cmdline.namefind |
  opennlp.tools.formats | Experimental package related to converting various corpora to OpenNLP Format.
  opennlp.tools.formats.ad |
  opennlp.tools.formats.brat |
  opennlp.tools.formats.convert |
  opennlp.tools.formats.masc |
  opennlp.tools.formats.muc |
  opennlp.tools.formats.ontonotes |
  opennlp.tools.namefind | Package related to finding proper names and numeric amounts.

- - ### Uses of NameSample in opennlp.tools.cmdline.namefind

    Methods in opennlp.tools.cmdline.namefind that return NameSample
    Modifier and Type | Method | Description
    --- | --- | ---
    `NameSample` | NameSampleCountersStream.`read()` |

    Methods in opennlp.tools.cmdline.namefind with parameters of type NameSample
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected Span[]` | TokenNameFinderDetailedFMeasureListener.`asSpanArray​(NameSample sample)` |
    `void` | TokenNameFinderFineGrainedReportListener.`correctlyClassified​(NameSample reference, NameSample prediction)` |
    `void` | NameEvaluationErrorListener.`missclassified​(NameSample reference, NameSample prediction)` |
    `void` | TokenNameFinderFineGrainedReportListener.`missclassified​(NameSample reference, NameSample prediction)` |

    Constructor parameters in opennlp.tools.cmdline.namefind with type arguments of type NameSample
    Constructor | Description
    --- | ---
    `NameSampleCountersStream​(ObjectStream<NameSample> samples)` |

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

    Methods in opennlp.tools.formats that return NameSample
    Modifier and Type | Method | Description
    --- | --- | ---
    `NameSample` | BioNLP2004NameSampleStream.`read()` |
    `NameSample` | Conll02NameSampleStream.`read()` |
    `NameSample` | Conll03NameSampleStream.`read()` |
    `NameSample` | EvalitaNameSampleStream.`read()` |

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

  - ### Uses of NameSample in opennlp.tools.formats.ad

    Methods in opennlp.tools.formats.ad that return NameSample
    Modifier and Type | Method | Description
    --- | --- | ---
    `NameSample` | ADNameSampleStream.`read()` |

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

  - ### Uses of NameSample in opennlp.tools.formats.brat

    Methods in opennlp.tools.formats.brat that return types with arguments of type NameSample
    Modifier and Type | Method | Description
    --- | --- | ---
    `ObjectStream<NameSample>` | BratNameSampleStreamFactory.`create​(String[] args)` |
    `List<NameSample>` | BratDocumentParser.`parse​(BratDocument sample)` |
    `protected List<NameSample>` | BratNameSampleStream.`read​(BratDocument sample)` |

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

    Methods in opennlp.tools.formats.convert with parameters of type NameSample
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected String[]` | NameToSentenceSampleStream.`toSentence​(NameSample sample)` |

    Constructor parameters in opennlp.tools.formats.convert with type arguments of type NameSample
    Constructor | Description
    --- | ---
    `NameToSentenceSampleStream​(Detokenizer detokenizer, ObjectStream<NameSample> samples, int chunkSize)` |
    `NameToTokenSampleStream​(Detokenizer detokenizer, ObjectStream<NameSample> samples)` |

  - ### Uses of NameSample in opennlp.tools.formats.masc

    Methods in opennlp.tools.formats.masc that return NameSample
    Modifier and Type | Method | Description
    --- | --- | ---
    `NameSample` | MascNamedEntitySampleStream.`read()` | Get the next sample of named entities.

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

  - ### Uses of NameSample in opennlp.tools.formats.muc

    Methods in opennlp.tools.formats.muc that return NameSample
    Modifier and Type | Method | Description
    --- | --- | ---
    `NameSample` | MucNameSampleStream.`read()` |

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

    Constructor parameters in opennlp.tools.formats.muc with type arguments of type NameSample
    Constructor | Description
    --- | ---
    `MucNameContentHandler​(Tokenizer tokenizer, List<NameSample> storedSamples)` |

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

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

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

  - ### Uses of NameSample in opennlp.tools.namefind

    Methods in opennlp.tools.namefind that return NameSample
    Modifier and Type | Method | Description
    --- | --- | ---
    `static NameSample` | NameSample.`parse​(String taggedTokens, boolean isClearAdaptiveData)` |
    `static NameSample` | NameSample.`parse​(String taggedTokens, String defaultType, boolean isClearAdaptiveData)` |
    `protected NameSample` | TokenNameFinderEvaluator.`processSample​(NameSample reference)` | Evaluates the given reference `NameSample` object.
    `NameSample` | NameSampleDataStream.`read()` |
    `NameSample` | NameSampleTypeFilter.`read()` |

    Methods in opennlp.tools.namefind with parameters of type NameSample
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected Iterator<Event>` | NameFinderEventStream.`createEvents​(NameSample sample)` |
    `protected NameSample` | TokenNameFinderEvaluator.`processSample​(NameSample reference)` | Evaluates the given reference `NameSample` object.

    Method parameters in opennlp.tools.namefind with type arguments of type NameSample
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | TokenNameFinderCrossValidator.`evaluate​(ObjectStream<NameSample> samples, int nFolds)` | Starts the evaluation.
    `static TokenNameFinderModel` | NameFinderME.`train​(String languageCode, String type, ObjectStream<NameSample> samples, TrainingParameters trainParams, TokenNameFinderFactory factory)` |

    Constructor parameters in opennlp.tools.namefind with type arguments of type NameSample
    Constructor | Description
    --- | ---
    `NameFinderEventStream​(ObjectStream<NameSample> dataStream)` |
    `NameFinderEventStream​(ObjectStream<NameSample> dataStream, String type, NameContextGenerator contextGenerator, SequenceCodec<String> codec)` | Creates a new name finder event stream using the specified data stream and context generator.
    `NameSampleSequenceStream​(ObjectStream<NameSample> psi)` |
    `NameSampleSequenceStream​(ObjectStream<NameSample> psi, NameContextGenerator pcg)` |
    `NameSampleSequenceStream​(ObjectStream<NameSample> psi, NameContextGenerator pcg, boolean useOutcomes)` |
    `NameSampleSequenceStream​(ObjectStream<NameSample> psi, NameContextGenerator pcg, boolean useOutcomes, SequenceCodec<String> seqCodec)` |
    `NameSampleSequenceStream​(ObjectStream<NameSample> psi, AdaptiveFeatureGenerator featureGen)` |
    `NameSampleSequenceStream​(ObjectStream<NameSample> psi, AdaptiveFeatureGenerator featureGen, boolean useOutcomes)` |
    `NameSampleTypeFilter​(String[] types, ObjectStream<NameSample> samples)` |
    `NameSampleTypeFilter​(Set<String> types, ObjectStream<NameSample> samples)` |