Index

A B C D E F G H I K L M N O P R S T U V W Z 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

abbreviation() - Method in record class opennlp.tools.util.normalizer.UnicodeWhitespace.RelatedCharacter
Returns the value of the abbreviation record component.
abbreviation() - Method in record class opennlp.tools.util.normalizer.UnicodeWhitespace.WhitespaceCharacter
Returns the value of the abbreviation record component.
AbstractObjectStream<T> - Class in opennlp.tools.util
A base ObjectStream implementation.
accept(int, String[]) - Method in interface opennlp.tools.document.DocumentAnnotators.SentenceTokenConsumer
Consumes one sentence's tokens.
ACCURACY - Enum constant in enum class opennlp.tools.monitoring.TrainingMeasure
 
AdaptiveFeatureGenerator - Interface in opennlp.tools.util.featuregen
An interface for generating features for name entity identification and for updating document level contexts.
add(double) - Method in class opennlp.tools.util.eval.Mean
Adds a value to the arithmetic mean.
add(double, long) - Method in class opennlp.tools.util.eval.Mean
Adds a value count times to the arithmetic mean.
add(String, double) - Method in class opennlp.tools.util.Sequence
Adds an outcome and probability to this sequence.
add(DocumentAnnotator) - Method in class opennlp.tools.document.DocumentAnalyzer.Builder
Appends an annotator to the pipeline.
add(Parse, HeadRules) - Method in class opennlp.tools.parser.Parse
 
addFeatureGenerator(AdaptiveFeatureGenerator) - Method in interface opennlp.tools.namefind.NameContextGenerator
Adds a feature generator.
additionalData() - Method in record class opennlp.tools.util.TokenTag
Returns the value of the additionalData record component.
addNames(String, Span[], Parse[]) - Static method in class opennlp.tools.parser.Parse
Utility method to insert named entities.
addNextPunctuation(Parse) - Method in class opennlp.tools.parser.Parse
Designates that the specified punctuation follows this parse.
addPreviousPunctuation(Parse) - Method in class opennlp.tools.parser.Parse
Designates that the specified punctuation should is prior to this parse.
addProb(double) - Method in class opennlp.tools.parser.Parse
Adds the specified logProb to this current log for this parse.
adjoin(Parse, HeadRules) - Method in class opennlp.tools.parser.Parse
Sister adjoins this node's last child and the specified sister node and returns their new parent node.
adjoinRoot(Parse, HeadRules, int) - Method in class opennlp.tools.parser.Parse
 
algorithm() - Method in interface opennlp.tools.util.Parameters
 
algorithm(String) - Method in interface opennlp.tools.util.Parameters
 
ALGORITHM_DEFAULT_VALUE - Static variable in interface opennlp.tools.util.Parameters
 
ALGORITHM_PARAM - Static variable in interface opennlp.tools.util.Parameters
 
AlgorithmType - Enum Class in opennlp.tools.ml
 
AlignedText - Record Class in opennlp.tools.util.normalizer
The result of a normalization that keeps the original text alongside the normalized form and a full Alignment between them.
AlignedText(CharSequence, CharSequence, Alignment) - Constructor for record class opennlp.tools.util.normalizer.AlignedText
Validates the components.
alignment() - Method in record class opennlp.tools.util.normalizer.AlignedText
Returns the value of the alignment record component.
Alignment - Class in opennlp.tools.util.normalizer
A bidirectional alignment between an original text and a normalized form of it.
Alignment.Builder - Class in opennlp.tools.util.normalizer
Builds an Alignment as the normalized text is produced, by recording each edit in order.
all() - Static method in class opennlp.tools.util.normalizer.UnicodeDash
Returns all Unicode dash characters, in ascending code point order.
all() - Static method in class opennlp.tools.util.normalizer.UnicodeWhitespace
Returns the 25 Unicode whitespace characters, in ascending code point order.
ALLOWED_KEY_SUFFIX - Static variable in class opennlp.tools.util.ext.Providers
The suffix of the configuration key that limits which provider classes may be used, see Providers.allowedKey().
ALLOWED_PACKAGES_PROPERTY - Static variable in class opennlp.tools.util.ext.ExtensionLoader
System property for supplying additional allowed package prefixes.
allowedKey() - Method in class opennlp.tools.util.ext.Providers
 
AmbiguousProviderException - Exception Class in opennlp.tools.util.ext
Thrown if more than one provider has the highest priority.
AmbiguousProviderException(String) - Constructor for exception class opennlp.tools.util.ext.AmbiguousProviderException
Initializes the exception.
analyze(CharSequence) - Method in class opennlp.tools.document.DocumentAnalyzer
Analyzes a text by running every annotator in order.
andThen(AlignedText) - Method in record class opennlp.tools.util.normalizer.AlignedText
Composes this result with a stage that further normalizes this result's normalized text.
andThen(Alignment) - Method in class opennlp.tools.util.normalizer.Alignment
Composes this alignment with one that further normalizes this alignment's normalized text.
annotate(Document) - Method in interface opennlp.tools.document.DocumentAnnotator
Annotates a document.
Annotation<T> - Record Class in opennlp.tools.document
One annotation of a Document: a typed value anchored to a Span of the document's original text, or a span-less value under a document-scoped key.
Annotation(Span, T) - Constructor for record class opennlp.tools.document.Annotation
Validates the annotation.
arcs() - Method in class opennlp.tools.depparse.DependencyTree
 
areOutcomesCompatible(String[]) - Method in interface opennlp.tools.util.SequenceCodec
Checks if the outcomes of a model are compatible with this SequenceCodec.
argmax(double[]) - Static method in class opennlp.tools.ml.ArrayMath
Finds the index of the maximum element in a vector x
ArgumentParser - Class in opennlp.tools.cmdline
Parser for command line arguments.
ArgumentParser.OptionalParameter - Annotation Interface in opennlp.tools.cmdline
 
ArgumentParser.ParameterDescription - Annotation Interface in opennlp.tools.cmdline
 
ArrayMath - Class in opennlp.tools.ml
Utility class for simple vector arithmetic.
ArrayMath() - Constructor for class opennlp.tools.ml.ArrayMath
 
ArtifactProvider - Interface in opennlp.tools.util.model
Provides access to model persisted artifacts.
ArtifactSerializer<T> - Interface in opennlp.tools.util.model
Responsible to create an artifact from an InputStream.
ASCII_DIGIT_STRINGS - Static variable in class opennlp.tools.util.StringUtil
The immutable list of the ten ASCII digit strings "0" to "9", indexed by digit value.
ATTACH - Enum constant in enum class opennlp.tools.parser.ParserEventTypeEnum
 

B

BaseLink - Class in opennlp.tools.entitylinker
Represents a minimal tuple of information.
BaseLink(String, String, String, String) - Constructor for class opennlp.tools.entitylinker.BaseLink
 
BasicFormatParams - Interface in opennlp.tools.cmdline.params
Common format parameters.
BasicTrainingParams - Interface in opennlp.tools.cmdline.params
Common training parameters.
BeamSearchContextGenerator<T> - Interface in opennlp.tools.util
Interface for context generators used with a sequence beam search.
BERT_CLS_TOKEN - Static variable in class opennlp.tools.tokenize.WordpieceTokenizer
BERT classification token: [CLS].
BERT_SEP_TOKEN - Static variable in class opennlp.tools.tokenize.WordpieceTokenizer
BERT separator token: [SEP].
BERT_UNK_TOKEN - Static variable in class opennlp.tools.tokenize.WordpieceTokenizer
BERT unknown token: [UNK].
bestSequence(T[], Object[], BeamSearchContextGenerator, SequenceValidator) - Method in interface opennlp.tools.ml.model.SequenceClassificationModel
Finds the Sequence with the highest probability.
bestSequences(int, T[], Object[], double, BeamSearchContextGenerator, SequenceValidator) - Method in interface opennlp.tools.ml.model.SequenceClassificationModel
Finds the n most probable sequences with the highest probability.
bestSequences(int, T[], Object[], BeamSearchContextGenerator, SequenceValidator) - Method in interface opennlp.tools.ml.model.SequenceClassificationModel
Finds the n most probable sequences with the highest probability.
BRACKET_LCB - Static variable in class opennlp.tools.parser.Parse
 
BRACKET_LRB - Static variable in class opennlp.tools.parser.Parse
 
BRACKET_LSB - Static variable in class opennlp.tools.parser.Parse
 
BRACKET_RCB - Static variable in class opennlp.tools.parser.Parse
 
BRACKET_RRB - Static variable in class opennlp.tools.parser.Parse
 
BRACKET_RSB - Static variable in class opennlp.tools.parser.Parse
 
breaking() - Method in record class opennlp.tools.util.normalizer.UnicodeWhitespace.WhitespaceCharacter
Returns the value of the breaking record component.
build() - Method in class opennlp.tools.document.DocumentAnalyzer.Builder
Validates the pipeline and builds the analyzer.
build(int) - Method in class opennlp.tools.util.normalizer.Alignment.Builder
Finalizes the alignment.
BUILD - Enum constant in enum class opennlp.tools.parser.ParserEventTypeEnum
 
builder() - Static method in class opennlp.tools.document.DocumentAnalyzer
 
Builder() - Constructor for class opennlp.tools.util.normalizer.Alignment.Builder
Creates a builder with a small default capacity of Alignment.Builder.DEFAULT_CAPACITY entries.
Builder(int) - Constructor for class opennlp.tools.util.normalizer.Alignment.Builder
Creates a builder pre-sized for a normalized text of about expectedLength characters, so recording the edits of a typical pass (one entry per normalized character) does not regrow the backing arrays.
byCodePoint(int) - Static method in class opennlp.tools.util.normalizer.UnicodeDash
Looks up the reference entry for a dash code point.
byCodePoint(int) - Static method in class opennlp.tools.util.normalizer.UnicodeWhitespace
Looks up the reference entry for a whitespace code point.
byName(String) - Method in class opennlp.tools.util.ext.Providers
Resolves an available provider by name, unless the name is disabled.

C

Cache<K,V> - Class in opennlp.tools.util
Provides fixed size, pre-allocated, least recently used replacement cache.
Cache(int) - Constructor for class opennlp.tools.util.Cache
 
calculateProbability(String...) - Method in interface opennlp.tools.languagemodel.LanguageModel
Calculate the probability of a series of tokens (e.g. a sentence), given a vocabulary.
CARRIAGE_RETURN - Static variable in class opennlp.tools.util.normalizer.UnicodeWhitespace
U+000D CARRIAGE RETURN, the first half of a CRLF line break.
categorize(String[]) - Method in interface opennlp.tools.doccat.DocumentCategorizer
Categorizes the given text, provided in separate tokens.
categorize(String[], Map) - Method in interface opennlp.tools.doccat.DocumentCategorizer
Categorizes the given text provided as tokens along with the provided extraInformation.
category() - Method in record class opennlp.tools.util.normalizer.UnicodeDash.DashCharacter
Returns the value of the category record component.
category() - Method in record class opennlp.tools.util.normalizer.UnicodeWhitespace.WhitespaceCharacter
Returns the value of the category record component.
Cc - Enum constant in enum class opennlp.tools.util.normalizer.UnicodeWhitespace.Category
Cc - control.
Cf - Enum constant in enum class opennlp.tools.util.normalizer.UnicodeWhitespace.Category
Cf - format (the related, non-whitespace code points).
CharClass - Class in opennlp.tools.util.normalizer
A configurable class of Unicode code points and the cursor based operations over it.
CharSequenceNormalizer - Interface in opennlp.tools.util.normalizer
A char sequence normalizer, used to adjusting (prune, substitute, add, etc.) characters in order to remove noise from text
CHECK - Enum constant in enum class opennlp.tools.parser.ParserEventTypeEnum
 
chunk(String[], String[]) - Method in interface opennlp.tools.chunker.Chunker
Generates chunk tags for the given sequence returning the result in an array.
CHUNK - Enum constant in enum class opennlp.tools.parser.ParserEventTypeEnum
Deprecated.
chunkAsSpans(String[], String[]) - Method in interface opennlp.tools.chunker.Chunker
Generates tagged chunk spans for the given sequence returning the result in a span array.
Chunker - Interface in opennlp.tools.chunker
The interface for chunkers which provide chunk tags for a sequence of tokens.
CHUNKER - Enum constant in enum class opennlp.tools.models.ModelType
 
ChunkerContextGenerator - Interface in opennlp.tools.chunker
Interface for a BeamSearchContextGenerator used in syntactic chunking.
ChunkerEvaluationMonitor - Interface in opennlp.tools.chunker
A marker interface for evaluating chunkers.
CHUNKING - Enum constant in enum class opennlp.tools.parser.ParserType
 
ChunkSample - Class in opennlp.tools.chunker
Class for holding chunks for a single unit of text.
ChunkSample(String[], String[], String[]) - Constructor for class opennlp.tools.chunker.ChunkSample
Initializes a ChunkSample instance.
ChunkSample(List, List, List) - Constructor for class opennlp.tools.chunker.ChunkSample
Initializes a ChunkSample instance.
ClassPathLoaderException - Exception Class in opennlp.tools.models
 
ClassPathLoaderException(String) - Constructor for exception class opennlp.tools.models.ClassPathLoaderException
 
ClassPathLoaderException(String, Throwable) - Constructor for exception class opennlp.tools.models.ClassPathLoaderException
 
ClassPathLoaderException(Throwable) - Constructor for exception class opennlp.tools.models.ClassPathLoaderException
 
ClassPathModelEntry - Record Class in opennlp.tools.models
Encapsulates a classpath entry that is associated with a model URI and optional properties.
ClassPathModelEntry(URI, Optional) - Constructor for record class opennlp.tools.models.ClassPathModelEntry
Creates an instance of a ClassPathModelEntry record class.
ClassPathModelFinder - Interface in opennlp.tools.models
Describes a scanner which detects OpenNLP specific model files in an applications's classpath.
clearAdaptiveData() - Method in interface opennlp.tools.namefind.NameContextGenerator
Informs all the feature generators that the context of the adaptive data (typically a document) is no longer valid and should be cleared.
clearAdaptiveData() - Method in interface opennlp.tools.namefind.TokenNameFinder
Forgets all adaptive data which was collected during previous calls to one of the find methods.
clearAdaptiveData() - Method in interface opennlp.tools.util.featuregen.AdaptiveFeatureGenerator
Informs a feature generator that the context of the adaptive data (typically a document) is no longer valid.
clone() - Method in class opennlp.tools.parser.Parse
 
clone(Parse) - Method in class opennlp.tools.parser.Parse
Clones the right frontier of Parse up to the specified node.
cloneRoot(Parse, int) - Method in class opennlp.tools.parser.Parse
Clones the right frontier of this root Parse up to and including the specified node.
close() - Method in interface opennlp.tools.embeddings.TextEmbedder
Releases resources owned by this embedder.
close() - Method in class opennlp.tools.util.AbstractObjectStream
 
close() - Method in interface opennlp.tools.util.ObjectStream
Closes the ObjectStream and releases all allocated resources.
close() - Method in class opennlp.tools.util.PlainTextByLineStream
 
codePoint() - Method in record class opennlp.tools.util.normalizer.UnicodeDash.DashCharacter
Returns the value of the codePoint record component.
codePoint() - Method in record class opennlp.tools.util.normalizer.UnicodeWhitespace.RelatedCharacter
Returns the value of the codePoint record component.
codePoint() - Method in record class opennlp.tools.util.normalizer.UnicodeWhitespace.WhitespaceCharacter
Returns the value of the codePoint record component.
codePoints() - Static method in class opennlp.tools.util.normalizer.UnicodeDash
Returns all dash code points, in ascending order, including the mathematical minus signs.
codePoints() - Static method in class opennlp.tools.util.normalizer.UnicodeWhitespace
Returns the whitespace code points, in ascending order.
CodePointSet - Class in opennlp.tools.util.normalizer
An immutable set of Unicode code points with O(1) membership.
codePointTokens(CharSequence) - Static method in class opennlp.tools.util.normalizer.HexCodePoints
Splits a sequence into its hex code point tokens.
collapse(CharSequence) - Method in class opennlp.tools.util.normalizer.CharClass
Collapses each maximal run of member code points to a single replacement.
collapseAligned(CharSequence) - Method in class opennlp.tools.util.normalizer.CharClass
Like CharClass.collapse(CharSequence) but also produces the Alignment back to the original text.
collapseParagraphPreserving(CharSequence, CodePointSet, int) - Method in class opennlp.tools.util.normalizer.CharClass
Collapses runs of members like CharClass.collapse(CharSequence), but emits paragraphReplacement when a run contains two or more logical line breaks, or the usual replacement when it contains at most one.
collapseParagraphPreservingAligned(CharSequence, CodePointSet, int) - Method in class opennlp.tools.util.normalizer.CharClass
Like CharClass.collapseParagraphPreserving(CharSequence, CodePointSet, int) but also produces the Alignment back to the original text.
collapsePreserving(CharSequence, CodePointSet, int) - Method in class opennlp.tools.util.normalizer.CharClass
Collapses runs of members like CharClass.collapse(CharSequence), but emits keepReplacement instead of the usual replacement for any run that contains a code point in keep.
collapsePreservingAligned(CharSequence, CodePointSet, int) - Method in class opennlp.tools.util.normalizer.CharClass
Like CharClass.collapsePreserving(CharSequence, CodePointSet, int) but also produces the Alignment back to the original text.
compareTo(Parse) - Method in class opennlp.tools.parser.Parse
 
compareTo(Sequence) - Method in class opennlp.tools.util.Sequence
 
compareTo(Span) - Method in class opennlp.tools.util.Span
Compares the specified Span to the current span.
CompatibilityMode - Enum Class in opennlp.tools.util
Selects, for the classes that corrected their output in 3.0.0, between the corrected output and the output of the 1.x/2.x releases.
complete() - Method in class opennlp.tools.parser.Parse
 
computeShortestEditScript(String, String, int[][], StringBuffer) - Static method in class opennlp.tools.util.StringUtil
Computes the Shortest Edit Script (SES) to convert a word into its lemma.
concatenateObjectStream(Collection) - Static method in class opennlp.tools.util.ObjectStreamUtils
Creates a single concatenated ObjectStream from multiple individual streams with the same type T.
concatenateObjectStream(ObjectStream...) - Static method in class opennlp.tools.util.ObjectStreamUtils
Creates a single concatenated ObjectStream from multiple individual streams with the same type.
CONFIGURATION_FILE - Static variable in class opennlp.tools.util.ext.Providers
The resource read for configuration keys, once per lookup and class loader, encoded in UTF-8.
CONFIGURATION_KEY_PREFIX - Static variable in class opennlp.tools.util.ext.Providers
The prefix of the configuration key that selects a provider by name for Providers.select(ProviderSpec).
configurationKey() - Method in class opennlp.tools.util.ext.Providers
 
Constituent - Class in opennlp.tools.parser
Holds constituents when reading parses.
Constituent(String, Span) - Constructor for class opennlp.tools.parser.Constituent
 
contains(int) - Method in class opennlp.tools.util.normalizer.CharClass
Tests membership.
contains(int) - Method in class opennlp.tools.util.normalizer.CodePointSet
Tests membership.
contains(int) - Method in class opennlp.tools.util.Span
An index with the value of end is considered outside the Span.
contains(Span) - Method in class opennlp.tools.util.Span
Identical spans are considered to contain each other.
containsAsciiDigit(CharSequence) - Static method in class opennlp.tools.util.StringUtil
Tests whether input contains an ASCII digit, 0 to 9.
containsAsciiUpperCase(CharSequence) - Static method in class opennlp.tools.util.StringUtil
Tests whether input contains an ASCII capital letter, A to Z.
context() - Method in record class opennlp.tools.langdetect.LanguageSample
Returns the value of the context record component.
Context - Class in opennlp.tools.ml.model
Class which associates a real valued parameter or expected value with a particular contextual predicate or feature.
Context(int[], double[]) - Constructor for class opennlp.tools.ml.model.Context
Creates a new parameters object with the specified parameters associated with the specified outcome pattern.
correctlyClassified(T, T) - Method in interface opennlp.tools.util.eval.EvaluationMonitor
 
count() - Method in class opennlp.tools.util.eval.Mean
 
count(String, int) - Static method in record class opennlp.tools.termvector.TermVector
Creates a scoring-only TermVector that carries the occurrence count without any offsets.
create(InputStream) - Method in interface opennlp.tools.util.model.ArtifactSerializer
Creates an artifact from the provided InputStream.
create(String[]) - Method in interface opennlp.tools.cmdline.ObjectStreamFactory
Creates an ObjectStream of the template type T.
create(String[], String[]) - Static method in record class opennlp.tools.util.TokenTag
 
create(ProviderSpec) - Method in interface opennlp.tools.util.ext.Provider
Creates a new instance.
createArguments(Class...) - Static method in class opennlp.tools.cmdline.ArgumentParser
Outputs the arguments as a data structure, so it can be used to create documentation.
createFeatures(List, String[], int, String[]) - Method in interface opennlp.tools.util.featuregen.AdaptiveFeatureGenerator
Adds the appropriate features for the token at the specified index with the specified array of previousOutcomes to the specified list of features.
createFromTokens(String[]) - Static method in class opennlp.tools.parser.Parse
Creates a Parse structure from an array of pre-tokenized strings.
createInputStream() - Method in interface opennlp.tools.util.InputStreamFactory
 
createObjectStream(Collection) - Static method in class opennlp.tools.util.ObjectStreamUtils
Creates an ObjectStream form a Collection<T>.
createObjectStream(T...) - Static method in class opennlp.tools.util.ObjectStreamUtils
Creates an ObjectStream form an array of T.
createSequenceValidator() - Method in interface opennlp.tools.util.SequenceCodec
 
createUsage(Class...) - Static method in class opennlp.tools.cmdline.ArgumentParser
Creates a usage string which can be printed in case the user did specify the arguments incorrectly.
createUsage(Class) - Static method in class opennlp.tools.cmdline.ArgumentParser
Creates a usage string which can be printed in case the user did specify the arguments incorrectly.
crosses(Span) - Method in class opennlp.tools.util.Span
Checks if the specified Span crosses this span.
current() - Static method in enum class opennlp.tools.util.CompatibilityMode
Returns the active CompatibilityMode: the value resolved from the "opennlp.compat.mode" system property when this class was initialized, or the value most recently passed to CompatibilityMode.setActive(CompatibilityMode).
current() - Static method in enum class opennlp.tools.util.WhitespaceMode
Returns the active WhitespaceMode: the value resolved from the "opennlp.whitespace.mode" system property when this class was initialized, or the value most recently passed to WhitespaceMode.setActive(WhitespaceMode).
CURRENT - Enum constant in enum class opennlp.tools.util.CompatibilityMode
The corrected output.
CUTOFF_DEFAULT_VALUE - Static variable in interface opennlp.tools.util.Parameters
The default cut off value is 5.
CUTOFF_PARAM - Static variable in interface opennlp.tools.util.Parameters
 
CVParams - Interface in opennlp.tools.cmdline.params
Common cross validator parameters.

D

DashCharacter(int, String, UnicodeDash.Category) - Constructor for record class opennlp.tools.util.normalizer.UnicodeDash.DashCharacter
Creates an instance of a DashCharacter record class.
dashes() - Static method in class opennlp.tools.util.normalizer.CharClass
Returns the dash preset: the Unicode Dash set excluding the mathematical minus signs, replacement U+002D.
DataIndexer<P> - Interface in opennlp.tools.ml.model
Represents an indexer which compresses events in memory and performs feature selection.
DataReader - Interface in opennlp.tools.ml.model
Describes generic ways to read data from a DataInputStream.
decode(List) - Method in interface opennlp.tools.util.SequenceCodec
Decodes a sequence of objects into Span objects.
decodeSequence(CharSequence) - Static method in class opennlp.tools.util.normalizer.HexCodePoints
Decodes a sequence of hex code points separated by runs of Unicode whitespace into the characters they name.
decodeSequence(CharSequence, char) - Static method in class opennlp.tools.util.normalizer.HexCodePoints
Decodes a sequence of hex code points separated by exactly one separator each into the characters they name.
decodeShortestEditScript(String, String) - Static method in class opennlp.tools.util.StringUtil
Reads the predicted Shortest Edit Script (SES) by a lemmatizer model and applies the permutations to obtain the lemma from the wordForm.
DEFAULT_CHARSET - Static variable in annotation interface opennlp.tools.cmdline.ArgumentParser.OptionalParameter
 
DEFAULT_PREFIX - Static variable in interface opennlp.tools.util.SequenceCodec
 
DEFAULT_SEPARATOR_CHARS - Static variable in class opennlp.tools.tokenize.TokenSample
 
DEFAULT_TYPE - Static variable in class opennlp.tools.namefind.NameSample
The default type value when there is no type in training data.
defaultDashCodePoints() - Static method in class opennlp.tools.util.normalizer.UnicodeDash
Returns the dash code points used for normalization by default, in ascending order.
defaultValue() - Element in annotation interface opennlp.tools.cmdline.ArgumentParser.OptionalParameter
 
DependencyArc - Record Class in opennlp.tools.depparse
One labeled edge of a DependencyTree: the token at dependent is governed by the token at head under the given relation.
DependencyArc(int, int, String) - Constructor for record class opennlp.tools.depparse.DependencyArc
Validates the arc invariants.
DependencyEvaluationMonitor - Interface in opennlp.tools.depparse
A marker interface for evaluating dependency parsers.
DependencyParser - Interface in opennlp.tools.depparse
The interface for dependency parsers, which assign every token of a sentence a syntactic head and a relation label, forming a single-rooted tree over the sentence.
DependencySample - Class in opennlp.tools.depparse
One dependency-annotated sentence: tokens, their part-of-speech tags, and the gold DependencyTree over them.
DependencySample(String[], String[], DependencyTree) - Constructor for class opennlp.tools.depparse.DependencySample
Initializes a DependencySample.
DependencyTree - Class in opennlp.tools.depparse
An immutable dependency tree over one sentence: for every token, the index of its head and the label of the relation to that head.
dependent() - Method in record class opennlp.tools.depparse.DependencyArc
Returns the value of the dependent record component.
description() - Element in annotation interface opennlp.tools.cmdline.ArgumentParser.ParameterDescription
 
detokenize(String[]) - Method in interface opennlp.tools.tokenize.Detokenizer
Detokenizes the collection of tokens.
detokenize(String[], String) - Method in interface opennlp.tools.tokenize.Detokenizer
Detokenizes the input tokens into a String.
Detokenizer - Interface in opennlp.tools.tokenize
A Detokenizer merges tokens back to their detokenized representation.
Detokenizer.DetokenizationOperation - Enum Class in opennlp.tools.tokenize
This enum contains an operation for every token to merge the tokens together to their detokenized form.
DetokenizerParameter - Interface in opennlp.tools.cmdline.params
 
dimension() - Method in interface opennlp.tools.embeddings.TextEmbedder
Returns the dimension of every vector this embedder produces.
dimension() - Method in interface opennlp.tools.util.wordvector.WordVector
 
dimension() - Method in interface opennlp.tools.util.wordvector.WordVectorTable
 
DISABLED_KEY_SUFFIX - Static variable in class opennlp.tools.util.ext.Providers
The suffix of the configuration key that disables providers by name, see Providers.disabledKey().
disabledKey() - Method in class opennlp.tools.util.ext.Providers
 
display(boolean) - Method in interface opennlp.tools.monitoring.TrainingProgressMonitor
Displays the training progress and optionally clears the recorded progress (to save memory).
DoccatEvaluationMonitor - Interface in opennlp.tools.doccat
A marker interface for evaluating doccat.
document(String, Class) - Static method in class opennlp.tools.document.LayerKey
Creates a document-scoped LayerKey for values that describe the document as a whole, for example a language id, a category distribution, or provenance.
Document - Interface in opennlp.tools.document
An offset-anchored annotation container: the original text of one document plus any number of typed annotation layers over it.
DOCUMENT - Enum constant in enum class opennlp.tools.document.LayerKey.Scope
The layer's values describe the document as a whole and carry no spans.
Document.DuplicateLayerPolicy - Enum Class in opennlp.tools.document
How Document.merge(Document, DuplicateLayerPolicy) treats a layer key that is present on both documents.
DocumentAnalyzer - Class in opennlp.tools.document
Runs a fixed sequence of annotators over a text, producing one Document that carries every step's layers.
DocumentAnalyzer.Builder - Class in opennlp.tools.document
Assembles a DocumentAnalyzer from annotators in execution order.
DocumentAnnotator - Interface in opennlp.tools.document
A pipeline step that reads layers from a Document and returns a new document with its own layers added.
DocumentAnnotatorProvider - Interface in opennlp.tools.document
The SPI for DocumentAnnotator providers.
DocumentAnnotators - Class in opennlp.tools.document
Support methods shared by DocumentAnnotator implementations: the required-layer and layer-alignment checks, the per-sentence walk over the token layer, and the mapping of sentence-relative token spans onto character spans.
DocumentAnnotators.SentenceTokenConsumer - Interface in opennlp.tools.document
Receives one sentence's contiguous token run during DocumentAnnotators.forEachSentence(List, List, SentenceTokenConsumer).
DocumentCategorizer - Interface in opennlp.tools.doccat
Interface for classes which categorize documents.
documentKey(String, Class) - Static method in class opennlp.tools.document.Layers
Creates a document-scoped key in the toolkit's opennlp: namespace, for a whole-document value the toolkit itself produces.
DocumentNameFinder - Interface in opennlp.tools.namefind
Interface for processing an entire document allowing a TokenNameFinder to use context from the entire document.
DocumentSample - Class in opennlp.tools.doccat
Class which holds a classified document and its category.
DocumentSample(String, String[]) - Constructor for class opennlp.tools.doccat.DocumentSample
Initializes a instance.
DocumentSample(String, String[], Map) - Constructor for class opennlp.tools.doccat.DocumentSample
Initializes a instance.
DOUBLE - Enum constant in enum class opennlp.tools.util.wordvector.WordVectorType
 

E

embed(CharSequence) - Method in interface opennlp.tools.embeddings.TextEmbedder
Embeds a piece of text.
embedAll(List) - Method in interface opennlp.tools.embeddings.TextEmbedder
Embeds several texts.
EmbeddingException - Exception Class in opennlp.tools.embeddings
Thrown if a TextEmbedder fails to embed text, for example because the inference backend reports an error.
EmbeddingException(String, Throwable) - Constructor for exception class opennlp.tools.embeddings.EmbeddingException
 
empty() - Static method in class opennlp.tools.util.ext.ProviderSpec
 
encode(CharSequence) - Method in interface opennlp.tools.tokenize.SubwordTokenizer
Encodes text into subword pieces.
encode(CharSequence) - Method in class opennlp.tools.tokenize.WordpieceEncoder
Encodes text into subword pieces.
encode(Span[], int) - Method in interface opennlp.tools.util.SequenceCodec
Encodes Span objects into a sequence of objects.
encodeToIds(CharSequence) - Method in interface opennlp.tools.tokenize.SubwordTokenizer
Encodes text into vocabulary ids.
encodeToPieces(CharSequence) - Method in interface opennlp.tools.tokenize.SubwordTokenizer
Encodes text into piece strings in the vocabulary's normalized form.
EncodingParameter - Interface in opennlp.tools.cmdline.params
Encoding parameter.
end() - Method in record class opennlp.tools.tokenize.SubwordPiece
Returns the value of the end record component.
END_TAG - Static variable in class opennlp.tools.namefind.NameSample
 
endOfAsciiDigits(CharSequence, int) - Static method in class opennlp.tools.util.StringUtil
Finds the end of the run of ASCII digits that starts at from.
EndOfSentenceScanner - Interface in opennlp.tools.sentdetect
Scans CharSequence, StringBuffer, and char[] for the offsets of sentence ending characters.
ENTITIES - Static variable in class opennlp.tools.document.Layers
Named entities; each annotation covers one mention and carries the entity type as its value.
EntityLinker<T> - Interface in opennlp.tools.entitylinker
EntityLinkers establish connections with external data to enrich extracted entities.
EntityLinkerProperties - Class in opennlp.tools.entitylinker
Properties wrapper for EntityLinker implementations.
EntityLinkerProperties(File) - Constructor for class opennlp.tools.entitylinker.EntityLinkerProperties
Initializes EntityLinkerProperties via a File reference.
EntityLinkerProperties(InputStream) - Constructor for class opennlp.tools.entitylinker.EntityLinkerProperties
Initializes EntityLinkerProperties via a InputStream reference.
equal(int) - Method in class opennlp.tools.util.normalizer.Alignment.Builder
Records charCount characters copied through unchanged (a one to one run).
equals(Object) - Method in class opennlp.tools.chunker.ChunkSample
 
equals(Object) - Method in record class opennlp.tools.depparse.DependencyArc
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class opennlp.tools.depparse.DependencySample
equals(Object) - Method in class opennlp.tools.depparse.DependencyTree
equals(Object) - Method in class opennlp.tools.doccat.DocumentSample
 
equals(Object) - Method in record class opennlp.tools.document.Annotation
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class opennlp.tools.document.LayerKey
equals(Object) - Method in class opennlp.tools.entitylinker.BaseLink
 
equals(Object) - Method in class opennlp.tools.entitylinker.LinkedSpan
 
equals(Object) - Method in class opennlp.tools.langdetect.Language
 
equals(Object) - Method in record class opennlp.tools.langdetect.LanguageSample
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class opennlp.tools.lemmatizer.LemmaSample
 
equals(Object) - Method in class opennlp.tools.ml.model.Context
 
equals(Object) - Method in record class opennlp.tools.models.ClassPathModelEntry
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class opennlp.tools.namefind.NameSample
 
equals(Object) - Method in class opennlp.tools.parser.Parse
 
equals(Object) - Method in class opennlp.tools.postag.POSSample
 
equals(Object) - Method in class opennlp.tools.sentdetect.SentenceSample
 
equals(Object) - Method in class opennlp.tools.sentiment.SentimentSample
 
equals(Object) - Method in record class opennlp.tools.termvector.TermVector
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class opennlp.tools.tokenize.SubwordPiece
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class opennlp.tools.tokenize.TokenSample
 
equals(Object) - Method in class opennlp.tools.util.ext.ProviderSpec
equals(Object) - Method in record class opennlp.tools.util.normalizer.AlignedText
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class opennlp.tools.util.normalizer.CodePointSet
 
equals(Object) - Method in record class opennlp.tools.util.normalizer.UnicodeDash.DashCharacter
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class opennlp.tools.util.normalizer.UnicodeWhitespace.RelatedCharacter
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class opennlp.tools.util.normalizer.UnicodeWhitespace.WhitespaceCharacter
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class opennlp.tools.util.Sequence
 
equals(Object) - Method in class opennlp.tools.util.Span
 
equals(Object) - Method in record class opennlp.tools.util.TokenTag
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class opennlp.tools.util.TrainingConfiguration
Indicates whether some other object is "equal to" this one.
eval(String[]) - Method in interface opennlp.tools.ml.model.MaxentModel
Evaluates a context.
eval(String[], double[]) - Method in interface opennlp.tools.ml.model.MaxentModel
Evaluates a context.
eval(String[], float[]) - Method in interface opennlp.tools.ml.model.MaxentModel
Evaluates a context with the specified context values.
EvaluationMonitor<T> - Interface in opennlp.tools.util.eval
 
EvaluatorParams - Interface in opennlp.tools.cmdline.params
Common evaluation parameters.
Event - Class in opennlp.tools.ml.model
The context of a decision point during training.
Event(String, CharSequence[]) - Constructor for class opennlp.tools.ml.model.Event
Instantiates an Event.
Event(String, CharSequence[], float[]) - Constructor for class opennlp.tools.ml.model.Event
Instantiates an Event.
Event(String, String[], float[]) - Constructor for class opennlp.tools.ml.model.Event
Instantiates an Event.
EVENT_VALUE - Static variable in interface opennlp.tools.ml.EventTrainer
 
EventModelSequenceTrainer<T,P> - Interface in opennlp.tools.ml
A specialized Trainer that is based on a 'EventModelSequence' approach.
EventTrainer<P> - Interface in opennlp.tools.ml
A specialized Trainer that is based on an Event approach.
expandTopNode(Parse) - Method in class opennlp.tools.parser.Parse
 
Experimental - Annotation Interface in opennlp.tools.util.java
Indicates that a certain API feature is not stable and might change with a new release.
ExtensionLoader - Class in opennlp.tools.util.ext
The ExtensionLoader is responsible to load extensions to the OpenNLP library.
ExtensionNotLoadedException - Exception Class in opennlp.tools.util.ext
Exception indicates that an OpenNLP extension could not be loaded.
ExtensionNotLoadedException(String) - Constructor for exception class opennlp.tools.util.ext.ExtensionNotLoadedException
 
ExtensionNotLoadedException(Throwable) - Constructor for exception class opennlp.tools.util.ext.ExtensionNotLoadedException
 
ExtensionServiceKeys - Class in opennlp.tools.util.ext
 
ExtensionServiceKeys() - Constructor for class opennlp.tools.util.ext.ExtensionServiceKeys
 
extractFeatures(String[], Map) - Method in interface opennlp.tools.doccat.FeatureGenerator
Extracts features from given text fragments.
extractTags(TokenTag[]) - Static method in record class opennlp.tools.util.TokenTag
 
extractTokens(TokenTag[]) - Static method in record class opennlp.tools.util.TokenTag
 

F

FeatureGenerator - Interface in opennlp.tools.doccat
Interface for generating features for document categorization.
FeatureGeneratorResourceProvider - Interface in opennlp.tools.util.featuregen
The FeatureGeneratorResourceProvider provides access to the resources available in the model.
filter(String[]) - Method in interface opennlp.tools.stopword.StopwordFilter
Returns a copy of tokens with stopword matches removed, preserving the input order.
filter(String[], Class) - Static method in class opennlp.tools.cmdline.ArgumentParser
Filters arguments leaving only those pertaining to argProxyInterface.
find(String[]) - Method in interface opennlp.tools.namefind.TokenNameFinder
Generates name tags for the given sequence, typically a sentence, returning token spans for any identified names.
find(String[][]) - Method in interface opennlp.tools.namefind.DocumentNameFinder
Finds tokens spans for the specified document of sentences and their tokens.
find(String, Span[], Span[][], Span[][]) - Method in interface opennlp.tools.entitylinker.EntityLinker
Links an entire document of named entities to an external source.
find(String, Span[], Span[][], Span[][], int) - Method in interface opennlp.tools.entitylinker.EntityLinker
Links the names that correspond to the tokens[] spans.
findInOriginal(String[]) - Method in interface opennlp.tools.namefind.OffsetMappingNameFinder
Finds names and returns their spans in the character coordinates of the original input, regardless of any normalization applied before detection.
findModels(boolean) - Method in interface opennlp.tools.models.ClassPathModelFinder
Finds OpenNLP models available within an applications's classpath.
FineGrainedEvaluatorParams - Interface in opennlp.tools.cmdline.params
Common evaluation parameters.
FINISHED - Static variable in interface opennlp.tools.monitoring.StopCriteria
 
finishedIteration(int, int, int, TrainingMeasure, double) - Method in interface opennlp.tools.monitoring.TrainingProgressMonitor
Captures the Iteration progress.
finishedTraining(int, StopCriteria) - Method in interface opennlp.tools.monitoring.TrainingProgressMonitor
Captures the training completion progress.
fixPossesives(Parse) - Static method in class opennlp.tools.parser.Parse
 
FLOAT - Enum constant in enum class opennlp.tools.util.wordvector.WordVectorType
 
FMeasure - Class in opennlp.tools.util.eval
The FMeasure is a utility class for evaluators which measures precision, recall and the resulting f-measure.
FMeasure() - Constructor for class opennlp.tools.util.eval.FMeasure
 
forEachSentence(List, List, DocumentAnnotators.SentenceTokenConsumer) - Static method in class opennlp.tools.document.DocumentAnnotators
Walks the token layer sentence by sentence and hands each sentence's contiguous token run to the consumer.
frequency() - Method in record class opennlp.tools.termvector.TermVector
Returns the value of the frequency record component.
fromAlgorithmType(String) - Static method in enum class opennlp.tools.ml.AlgorithmType
 
fromFile(Path, String) - Static method in class opennlp.tools.util.normalizer.CodePointSet
Loads the code points declared under one section of a user definitions file.
fromModelType(String) - Static method in enum class opennlp.tools.ml.AlgorithmType
 

G

GapLabeler - Interface in opennlp.tools.parser
Represents a labeler for nodes which contain traces so that these traces can be predicted by a Parser.
get(String) - Method in interface opennlp.tools.util.wordvector.WordVectorTable
 
get(LayerKey) - Method in interface opennlp.tools.document.Document
Retrieves the annotations of one layer.
getAdditionalContext() - Method in class opennlp.tools.namefind.NameSample
 
getAdditionalContext() - Method in class opennlp.tools.postag.POSSample
 
getAlgorithmType() - Method in enum class opennlp.tools.ml.AlgorithmType
 
getAllOutcomes(double[]) - Method in interface opennlp.tools.ml.model.MaxentModel
Retrieves a string matching all the outcome names with all the probabilities produced by the MaxentModel.eval(String[]) method.
getAllResults(double[]) - Method in interface opennlp.tools.doccat.DocumentCategorizer
Retrieves the name of the category associated with the given probabilities.
getArtifact(String) - Method in interface opennlp.tools.util.model.ArtifactProvider
 
getArtifactSerializerClass() - Method in interface opennlp.tools.util.model.SerializableArtifact
Retrieves the class which can serialize and recreate this artifact.
getAsDouble(int) - Method in interface opennlp.tools.util.wordvector.WordVector
 
getAsFloat(int) - Method in interface opennlp.tools.util.wordvector.WordVector
 
getBestCategory(double[]) - Method in interface opennlp.tools.doccat.DocumentCategorizer
Retrieves the best category from previously generated outcome probabilities
getBestOutcome(double[]) - Method in interface opennlp.tools.ml.model.MaxentModel
Retrieves the outcome associated with the index containing the highest probability in the double[].
getBooleanParameter(String, boolean) - Method in interface opennlp.tools.util.Parameters
Obtains a training parameter value.
getBooleanParameter(String, String, boolean) - Method in interface opennlp.tools.util.Parameters
Obtains a training parameter value in the specified namespace.
getCategory() - Method in class opennlp.tools.doccat.DocumentSample
 
getCategory(int) - Method in interface opennlp.tools.doccat.DocumentCategorizer
Retrieves the category at a given index.
getChildCount() - Method in class opennlp.tools.parser.Parse
 
getChildren() - Method in class opennlp.tools.parser.Parse
 
getCode() - Method in exception class opennlp.tools.cmdline.TerminateToolException
 
getCommonParent(Parse) - Method in class opennlp.tools.parser.Parse
Returns the deepest shared parent of this node and the specified node.
getConfidence() - Method in class opennlp.tools.langdetect.Language
 
getContext() - Method in class opennlp.tools.ml.model.Event
 
getContext(int, String[], String[], Object[]) - Method in interface opennlp.tools.postag.POSContextGenerator
Returns the context for making a postag decision at the specified token index given the specified tokens and previous tags.
getContext(int, String[], String[], String[]) - Method in interface opennlp.tools.chunker.ChunkerContextGenerator
Retrieves the contexts for chunking of the specified idx.
getContext(int, String[], String[], String[]) - Method in interface opennlp.tools.lemmatizer.LemmatizerContextGenerator
Returns the contexts for lemmatizing of the specified index.
getContext(int, T[], String[], Object[]) - Method in interface opennlp.tools.util.BeamSearchContextGenerator
Returns the context for the specified position in the specified sequence (list).
getContext(CharSequence) - Method in interface opennlp.tools.langdetect.LanguageDetectorContextGenerator
Retrieves the contexts for a document using character ngrams.
getContext(CharSequence, int) - Method in interface opennlp.tools.sentdetect.SDContextGenerator
Returns an array of contextual features for the potential sentence boundary at the specified position within the specified string buffer.
getContext(String, int) - Method in interface opennlp.tools.tokenize.TokenContextGenerator
 
getContexts() - Method in interface opennlp.tools.ml.model.DataIndexer
 
getCoveredText() - Method in class opennlp.tools.parser.Parse
 
getCoveredText(CharSequence) - Method in class opennlp.tools.util.Span
 
getData() - Method in interface opennlp.tools.cmdline.params.BasicFormatParams
 
getDataType() - Method in interface opennlp.tools.util.wordvector.WordVector
 
getDerivation() - Method in class opennlp.tools.parser.Parse
 
getDetokenizer() - Method in interface opennlp.tools.cmdline.params.DetokenizerParameter
 
getDocument() - Method in class opennlp.tools.sentdetect.SentenceSample
 
getDoubleParameter(String, double) - Method in interface opennlp.tools.util.Parameters
Obtains a training parameter value.
getDoubleParameter(String, String, double) - Method in interface opennlp.tools.util.Parameters
Obtains a training parameter value in the specified namespace.
getEncoding() - Method in interface opennlp.tools.cmdline.params.EncodingParameter
 
getEnd() - Method in class opennlp.tools.util.Span
Note: that the returned index is one past the actual end of the span in the text, or the first element past the end of the span.
getEOSCharacters() - Method in interface opennlp.tools.sentdetect.EndOfSentenceScanner
 
getEvents() - Method in class opennlp.tools.ml.model.Sequence
 
getExtraInformation() - Method in class opennlp.tools.doccat.DocumentSample
 
getFMeasure() - Method in class opennlp.tools.util.eval.FMeasure
f-measure = 2 * precision * recall / (precision + recall).
getFolds() - Method in interface opennlp.tools.cmdline.params.CVParams
 
getHead() - Method in class opennlp.tools.parser.Parse
 
getHead(Parse[], String) - Method in interface opennlp.tools.parser.HeadRules
Retrieves the head constituent for the specified constituents of given type.
getHeadIndex() - Method in class opennlp.tools.parser.Parse
 
getId() - Method in class opennlp.tools.namefind.NameSample
 
getIndex(String) - Method in interface opennlp.tools.doccat.DocumentCategorizer
Retrieves the index of a certain category.
getIndex(String) - Method in interface opennlp.tools.ml.model.MaxentModel
Retrieves the index associated with the String name of the given outcome.
getIntParameter(String, int) - Method in interface opennlp.tools.util.Parameters
Obtains a training parameter value.
getIntParameter(String, String, int) - Method in interface opennlp.tools.util.Parameters
Obtains a training parameter value in the specified namespace.
getItemID() - Method in class opennlp.tools.entitylinker.BaseLink
 
getItemName() - Method in class opennlp.tools.entitylinker.BaseLink
 
getItemParentID() - Method in class opennlp.tools.entitylinker.BaseLink
 
getItemType() - Method in class opennlp.tools.entitylinker.BaseLink
 
getKey(String, String) - Static method in interface opennlp.tools.util.Parameters
 
getLabel() - Method in class opennlp.tools.parser.Constituent
Returns the label of the constituent.
getLabel() - Method in class opennlp.tools.parser.Parse
Retrieves the label assigned to this parse node during parsing which specifies how this node will be formed into a constituent.
getLang() - Method in interface opennlp.tools.cmdline.params.LanguageParams
 
getLang() - Method in class opennlp.tools.langdetect.Language
 
getLanguage() - Method in interface opennlp.tools.util.model.ArtifactProvider
 
getLemmas() - Method in class opennlp.tools.lemmatizer.LemmaSample
 
getLinkedEntries() - Method in class opennlp.tools.entitylinker.LinkedSpan
 
getManifestProperty(String) - Method in interface opennlp.tools.util.model.ArtifactProvider
 
getMaxTokenLength() - Method in class opennlp.tools.tokenize.WordpieceTokenizer
Returns the maximum token length.
getMeasureName() - Method in enum class opennlp.tools.monitoring.TrainingMeasure
 
getMessage() - Method in exception class opennlp.tools.cmdline.TerminateToolException
 
getMessageIfSatisfied() - Method in interface opennlp.tools.monitoring.StopCriteria
 
getMisclassified() - Method in interface opennlp.tools.cmdline.params.CVParams
 
getMisclassified() - Method in interface opennlp.tools.cmdline.params.EvaluatorParams
 
getModel() - Method in interface opennlp.tools.cmdline.params.EvaluatorParams
 
getModel() - Method in interface opennlp.tools.cmdline.params.TrainingToolParams
 
getModelType() - Method in enum class opennlp.tools.ml.AlgorithmType
 
getName() - Method in enum class opennlp.tools.models.ModelType
 
getNames() - Method in class opennlp.tools.namefind.NameSample
 
getNextPunctuationSet() - Method in class opennlp.tools.parser.Parse
 
getNumberOfCategories() - Method in interface opennlp.tools.doccat.DocumentCategorizer
Retrieves the number of categories.
getNumEvents() - Method in interface opennlp.tools.ml.model.DataIndexer
 
getNumOutcomes() - Method in interface opennlp.tools.ml.model.MaxentModel
 
getNumTimesEventsSeen() - Method in interface opennlp.tools.ml.model.DataIndexer
 
getObjectSettings() - Method in interface opennlp.tools.util.Parameters
 
getObjectSettings(String) - Method in interface opennlp.tools.util.Parameters
 
getOutcome() - Method in class opennlp.tools.ml.model.Event
 
getOutcome(int) - Method in interface opennlp.tools.ml.model.MaxentModel
Retrieves the String name of the outcome associated with the index i.
getOutcome(int) - Method in class opennlp.tools.util.Sequence
 
getOutcomeLabels() - Method in interface opennlp.tools.ml.model.DataIndexer
 
getOutcomeList() - Method in interface opennlp.tools.ml.model.DataIndexer
 
getOutcomes() - Method in class opennlp.tools.ml.model.Context
 
getOutcomes() - Method in interface opennlp.tools.ml.model.SequenceClassificationModel
 
getOutcomes() - Method in class opennlp.tools.util.Sequence
 
getParameters() - Method in interface opennlp.tools.cmdline.ObjectStreamFactory
 
getParameters() - Method in class opennlp.tools.ml.model.Context
 
getParams() - Method in interface opennlp.tools.cmdline.params.BasicTrainingParams
 
getParent() - Method in class opennlp.tools.parser.Parse
 
getPhrasesAsSpanList() - Method in class opennlp.tools.chunker.ChunkSample
 
getPositions(char[]) - Method in interface opennlp.tools.sentdetect.EndOfSentenceScanner
The receiver scans cbuf for sentence ending characters and returns their offsets.
getPositions(CharSequence) - Method in interface opennlp.tools.sentdetect.EndOfSentenceScanner
The receiver scans the specified string for sentence ending characters and returns their offsets.
getPositions(StringBuffer) - Method in interface opennlp.tools.sentdetect.EndOfSentenceScanner
The receiver scans buf for sentence ending characters and returns their offsets.
getPrecisionScore() - Method in class opennlp.tools.util.eval.FMeasure
 
getPredCounts() - Method in interface opennlp.tools.ml.model.DataIndexer
 
getPredLabels() - Method in interface opennlp.tools.ml.model.DataIndexer
 
getPreds() - Method in class opennlp.tools.chunker.ChunkSample
 
getPreviousPunctuationSet() - Method in class opennlp.tools.parser.Parse
 
getProb() - Method in class opennlp.tools.parser.Parse
 
getProb() - Method in class opennlp.tools.util.Span
 
getProb(int) - Method in class opennlp.tools.util.Sequence
 
getProbs() - Method in class opennlp.tools.util.Sequence
 
getProbs(double[]) - Method in class opennlp.tools.util.Sequence
Populates an array with the probabilities associated with the Sequence outcomes.
getProperty(String, String) - Method in class opennlp.tools.entitylinker.EntityLinkerProperties
Retrieves a property value for a given key.
getPunctuationTags() - Method in interface opennlp.tools.parser.HeadRules
 
getReaderClazz() - Method in enum class opennlp.tools.ml.AlgorithmType
 
getRecallScore() - Method in class opennlp.tools.util.eval.FMeasure
 
getReportOutputFile() - Method in interface opennlp.tools.cmdline.params.FineGrainedEvaluatorParams
 
getResource(String) - Method in interface opennlp.tools.util.featuregen.FeatureGeneratorResourceProvider
 
getScore() - Method in class opennlp.tools.util.Sequence
 
getScoreMap() - Method in class opennlp.tools.entitylinker.BaseLink
 
getSearchTerm() - Method in class opennlp.tools.entitylinker.LinkedSpan
 
getSentence() - Method in class opennlp.tools.chunker.ChunkSample
 
getSentence() - Method in class opennlp.tools.namefind.NameSample
 
getSentence() - Method in class opennlp.tools.postag.POSSample
 
getSentence() - Method in class opennlp.tools.sentiment.SentimentSample
 
getSentenceid() - Method in class opennlp.tools.entitylinker.LinkedSpan
 
getSentences() - Method in class opennlp.tools.sentdetect.SentenceSample
 
getSentiment() - Method in class opennlp.tools.sentiment.SentimentSample
 
getShortestEditScript(String, String) - Static method in class opennlp.tools.util.StringUtil
 
getSize() - Method in class opennlp.tools.util.Sequence
 
getSource() - Method in class opennlp.tools.ml.model.Sequence
This object is used when the events for this sequence need to be re-derived such as in a call to SequenceStream.updateContext(Sequence, AbstractModel).
getSpan() - Method in class opennlp.tools.parser.Constituent
Returns the span of the constituent.
getSpan() - Method in class opennlp.tools.parser.Parse
 
getStart() - Method in class opennlp.tools.util.Span
 
getStringParameter(String, String) - Method in interface opennlp.tools.util.Parameters
Obtains a training parameter value.
getStringParameter(String, String, String) - Method in interface opennlp.tools.util.Parameters
Obtains a training parameter value in the specified namespace.
getSupportedLanguages() - Method in interface opennlp.tools.langdetect.LanguageDetector
 
getTagNodes() - Method in class opennlp.tools.parser.Parse
 
getTags() - Method in class opennlp.tools.chunker.ChunkSample
 
getTags() - Method in class opennlp.tools.depparse.DependencySample
 
getTags() - Method in class opennlp.tools.lemmatizer.LemmaSample
 
getTags() - Method in class opennlp.tools.postag.POSSample
 
getTags(String) - Method in interface opennlp.tools.postag.TagDictionary
Retrieves a list of valid tags for the specified word.
getTagSequenceProb() - Method in class opennlp.tools.parser.Parse
 
getText() - Method in class opennlp.tools.doccat.DocumentSample
 
getText() - Method in class opennlp.tools.parser.Parse
 
getText() - Method in class opennlp.tools.tokenize.TokenSample
 
getTokenNodes() - Method in class opennlp.tools.parser.Parse
 
getTokens() - Method in class opennlp.tools.depparse.DependencySample
 
getTokens() - Method in class opennlp.tools.lemmatizer.LemmaSample
 
getTokenSpans() - Method in class opennlp.tools.tokenize.TokenSample
 
getTrainerClazz() - Method in enum class opennlp.tools.ml.AlgorithmType
 
getTree() - Method in class opennlp.tools.depparse.DependencySample
 
getType() - Method in class opennlp.tools.parser.Parse
 
getType() - Method in class opennlp.tools.util.Span
 
getValues() - Method in interface opennlp.tools.ml.model.DataIndexer
 
getValues() - Method in class opennlp.tools.ml.model.Event
 
getWriterClazz() - Method in enum class opennlp.tools.ml.AlgorithmType
 

H

hashCode() - Method in class opennlp.tools.chunker.ChunkSample
 
hashCode() - Method in record class opennlp.tools.depparse.DependencyArc
Returns a hash code value for this object.
hashCode() - Method in class opennlp.tools.depparse.DependencySample
hashCode() - Method in class opennlp.tools.depparse.DependencyTree
hashCode() - Method in class opennlp.tools.doccat.DocumentSample
 
hashCode() - Method in record class opennlp.tools.document.Annotation
Returns a hash code value for this object.
hashCode() - Method in class opennlp.tools.document.LayerKey
hashCode() - Method in class opennlp.tools.entitylinker.BaseLink
 
hashCode() - Method in class opennlp.tools.entitylinker.LinkedSpan
 
hashCode() - Method in class opennlp.tools.langdetect.Language
 
hashCode() - Method in record class opennlp.tools.langdetect.LanguageSample
Returns a hash code value for this object.
hashCode() - Method in class opennlp.tools.lemmatizer.LemmaSample
 
hashCode() - Method in class opennlp.tools.ml.model.Context
 
hashCode() - Method in record class opennlp.tools.models.ClassPathModelEntry
Returns a hash code value for this object.
hashCode() - Method in class opennlp.tools.namefind.NameSample
 
hashCode() - Method in class opennlp.tools.parser.Parse
 
hashCode() - Method in class opennlp.tools.postag.POSSample
 
hashCode() - Method in class opennlp.tools.sentdetect.SentenceSample
 
hashCode() - Method in class opennlp.tools.sentiment.SentimentSample
 
hashCode() - Method in record class opennlp.tools.termvector.TermVector
Returns a hash code value for this object.
hashCode() - Method in record class opennlp.tools.tokenize.SubwordPiece
Returns a hash code value for this object.
hashCode() - Method in class opennlp.tools.tokenize.TokenSample
 
hashCode() - Method in class opennlp.tools.util.ext.ProviderSpec
hashCode() - Method in record class opennlp.tools.util.normalizer.AlignedText
Returns a hash code value for this object.
hashCode() - Method in class opennlp.tools.util.normalizer.CodePointSet
 
hashCode() - Method in record class opennlp.tools.util.normalizer.UnicodeDash.DashCharacter
Returns a hash code value for this object.
hashCode() - Method in record class opennlp.tools.util.normalizer.UnicodeWhitespace.RelatedCharacter
Returns a hash code value for this object.
hashCode() - Method in record class opennlp.tools.util.normalizer.UnicodeWhitespace.WhitespaceCharacter
Returns a hash code value for this object.
hashCode() - Method in class opennlp.tools.util.Sequence
 
hashCode() - Method in class opennlp.tools.util.Span
 
hashCode() - Method in record class opennlp.tools.util.TokenTag
Returns a hash code value for this object.
hashCode() - Method in record class opennlp.tools.util.TrainingConfiguration
Returns a hash code value for this object.
hasNext() - Method in class opennlp.tools.util.ReverseListIterator
 
hasOnlyOptions(String...) - Method in class opennlp.tools.util.ext.ProviderSpec
Checks whether every option of this spec has one of the given names.
head() - Method in record class opennlp.tools.depparse.DependencyArc
Returns the value of the head record component.
headOf(int) - Method in class opennlp.tools.depparse.DependencyTree
Retrieves the head of a token.
HeadRules - Interface in opennlp.tools.parser
Encoder for head rules associated with parsing.
HexCodePoints - Class in opennlp.tools.util.normalizer
Reads the hex code point notation of Unicode data files and similar code point tables: one code point as hex digits (1F600), a sequence as hex digits separated by whitespace (1F468 200D 1F469), and an inclusive range as two code points joined by two dots (1F3FB..1F3FF).
HYPHEN_MINUS - Static variable in class opennlp.tools.util.normalizer.UnicodeDash
The canonical ASCII dash that dashes are normalized to: U+002D HYPHEN-MINUS.

I

id() - Method in class opennlp.tools.document.LayerKey
 
id() - Method in record class opennlp.tools.tokenize.SubwordPiece
Returns the value of the id record component.
ID - Static variable in class opennlp.tools.util.ext.ExtensionServiceKeys
Property key for the unique id which identifies an OpenNLP extension service.
INC_NODE - Static variable in interface opennlp.tools.parser.Parser
The label for the top if an incomplete node.
index(ObjectStream) - Method in interface opennlp.tools.ml.model.DataIndexer
Performs the data indexing.
indexOf(Parse) - Method in class opennlp.tools.parser.Parse
 
indexOfLineTerminator(CharSequence, int) - Static method in class opennlp.tools.util.StringUtil
Finds the first line terminator at or after from, as defined by StringUtil.isLineTerminator(int).
init(EntityLinkerProperties) - Method in interface opennlp.tools.entitylinker.EntityLinker
Initializes an EntityLinker and allows for passing properties through an EntityLinkerFactory into all impls dynamically.
init(P, Map) - Method in interface opennlp.tools.commons.Trainer
Conducts the initialization of an Trainer via Parameters and a report map.
init(P, Map) - Method in interface opennlp.tools.ml.model.DataIndexer
Sets parameters used during the data indexing.
init(P, Map, TrainingConfiguration) - Method in interface opennlp.tools.commons.Trainer
Conducts the initialization of a Trainer via Parameters, report map and TrainingConfiguration
initLimit(String, long) - Static method in class opennlp.tools.util.ResourceLimits
Reads a positive long limit from a system property.
innerProduct(double[], double[]) - Static method in class opennlp.tools.ml.ArrayMath
 
InputStreamFactory - Interface in opennlp.tools.util
Allows repeated reads through a stream for certain model building types.
insert(Parse) - Method in class opennlp.tools.parser.Parse
Inserts the specified constituent into this parse based on its text span.
installed() - Method in class opennlp.tools.util.ext.Providers
 
INSTANCE - Static variable in class opennlp.tools.tokenize.WhitespaceTokenizer
Use this static reference to retrieve an instance of the WhitespaceTokenizer.
instantiateExtension(Class, String) - Static method in class opennlp.tools.util.ext.ExtensionLoader
Instantiates a user provided extension to OpenNLP.
InsufficientTrainingDataException - Exception Class in opennlp.tools.util
This exception indicates that the provided training data is insufficient to train a desired model.
InsufficientTrainingDataException(String) - Constructor for exception class opennlp.tools.util.InsufficientTrainingDataException
 
InsufficientTrainingDataException(String, Throwable) - Constructor for exception class opennlp.tools.util.InsufficientTrainingDataException
 
InsufficientTrainingDataException(Throwable) - Constructor for exception class opennlp.tools.util.InsufficientTrainingDataException
 
intern(String) - Method in interface opennlp.tools.util.jvm.StringInterner
Interns and returns a reference to the representative instance for any collection of string instances that are equal to each other.
Internal - Annotation Interface in opennlp.tools.commons
Classes, fields, or methods annotated &#64;Internal are for OpenNLP internal use only.
intersects(Span) - Method in class opennlp.tools.util.Span
Checks if the specified Span intersects with this span.
InvalidFormatException - Exception Class in opennlp.tools.util
This exception indicates that a resource violates the expected data format.
InvalidFormatException(String) - Constructor for exception class opennlp.tools.util.InvalidFormatException
 
InvalidFormatException(String, Throwable) - Constructor for exception class opennlp.tools.util.InvalidFormatException
 
InvalidFormatException(Throwable) - Constructor for exception class opennlp.tools.util.InvalidFormatException
 
invL2norm(double[]) - Static method in class opennlp.tools.ml.ArrayMath
Computes the Inverse L2-norm for a vector v.
isAsciiDigit(int) - Static method in class opennlp.tools.util.StringUtil
Tests for an ASCII digit, 0 to 9.
isAsciiLetter(int) - Static method in class opennlp.tools.util.StringUtil
Tests for an ASCII letter, a to z or A to Z.
isAsciiLowerCase(int) - Static method in class opennlp.tools.util.StringUtil
Tests for an ASCII lowercase letter, a to z.
isAsciiWhitespace(int) - Static method in class opennlp.tools.util.StringUtil
Tests for an ASCII whitespace character: space, tab, line feed, vertical tab, form feed or carriage return.
isAvailable() - Method in interface opennlp.tools.util.ext.Provider
Checks whether this provider can be used in the running process, for example whether an optional dependency is on the class path.
isBlank(CharSequence) - Static method in class opennlp.tools.util.StringUtil
Determines whether a CharSequence is blank: empty, or made up entirely of code points that StringUtil.isWhitespace(int) accepts.
isCaseSensitive() - Method in interface opennlp.tools.postag.TagDictionary
Whether the dictionary is case-sensitive or not.
isCaseSensitive() - Method in interface opennlp.tools.stopword.StopwordFilter
 
isChunk() - Method in class opennlp.tools.parser.Parse
 
isChunk(boolean) - Method in class opennlp.tools.parser.Parse
 
isClearAdaptiveDataSet() - Method in class opennlp.tools.namefind.NameSample
 
isClearAdaptiveDataSet() - Method in class opennlp.tools.sentiment.SentimentSample
 
isDash(int) - Static method in class opennlp.tools.util.normalizer.UnicodeDash
Tests whether a code point carries the Unicode Dash property.
isEmpty() - Method in class opennlp.tools.util.normalizer.CodePointSet
Returns whether this set is empty.
isEmpty(CharSequence) - Static method in class opennlp.tools.util.StringUtil
Determines whether a CharSequence is empty.
isFlat() - Method in class opennlp.tools.parser.Parse
Indicates whether this parse node contains no sub-constituents.
isLineBreak() - Method in record class opennlp.tools.util.normalizer.UnicodeWhitespace.WhitespaceCharacter
Returns whether this code point forces a line or paragraph break.
isLineTerminator(int) - Static method in class opennlp.tools.util.StringUtil
Tests for a line terminator: line feed U+000A, carriage return U+000D, next line U+0085, line separator U+2028, or paragraph separator U+2029.
isLoadedFromSerialized() - Method in interface opennlp.tools.util.model.ArtifactProvider
Indicates if this provider was loaded from a serialized form.
isLookalike(int) - Static method in class opennlp.tools.util.normalizer.UnicodeWhitespace
Tests whether a code point is one of the related, non-whitespace look-alike format characters.
isMathematical() - Method in record class opennlp.tools.util.normalizer.UnicodeDash.DashCharacter
Returns whether this is a mathematical minus sign (category Sm).
isNonBreaking() - Method in record class opennlp.tools.util.normalizer.UnicodeWhitespace.WhitespaceCharacter
Returns whether this is a non-breaking space.
isPosTag() - Method in class opennlp.tools.parser.Parse
Indicates whether this parse node is a pos-tag.
isStopword(CharSequence) - Method in interface opennlp.tools.stopword.StopwordFilter
Checks whether the given token is a single-token stopword.
isStopword(String...) - Method in interface opennlp.tools.stopword.StopwordFilter
Checks whether the given sequence of tokens is a multi-token stopword (n-gram).
isSupplementary() - Method in record class opennlp.tools.util.normalizer.UnicodeDash.DashCharacter
Returns whether this code point is outside the Basic Multilingual Plane.
isTrainingFinished() - Method in interface opennlp.tools.monitoring.TrainingProgressMonitor
Checks whether the training has finished.
isUnicodeBlank(CharSequence) - Static method in class opennlp.tools.util.StringUtil
true when input is null, empty, or consists only of Unicode White_Space code points.
isUnicodeWhitespace(char) - Static method in class opennlp.tools.util.StringUtil
Determines if the specified Character is a whitespace under the Unicode White_Space property; delegates to UnicodeWhitespace.isWhitespace(int).
isUnicodeWhitespace(int) - Static method in class opennlp.tools.util.StringUtil
Determines if the specified code point is a whitespace under the Unicode White_Space property; delegates to UnicodeWhitespace.isWhitespace(int).
isUnpairedSurrogate(int) - Static method in class opennlp.tools.util.StringUtil
Checks whether a code point taken from a CharSequence is a lone surrogate, U+D800 to U+DFFF, rather than a character.
isValid(String) - Static method in class opennlp.tools.util.LanguageCodeValidator
Checks whether the given language code is a valid ISO 639 code.
isWhitespace(char) - Static method in class opennlp.tools.util.StringUtil
Determines if the specified Character is a whitespace under the active WhitespaceMode: the Unicode White_Space property by default, or, when the "opennlp.whitespace.mode" system property selects WhitespaceMode.LEGACY, the union of Character.isWhitespace(int) and the Unicode Zs category (Character.SPACE_SEPARATOR) that OpenNLP 1.x and 2.x used.
isWhitespace(int) - Static method in class opennlp.tools.util.normalizer.UnicodeWhitespace
Tests whether a code point carries the Unicode White_Space property.
isWhitespace(int) - Static method in class opennlp.tools.util.StringUtil
Determines if the specified code point is a whitespace under the active WhitespaceMode; see StringUtil.isWhitespace(char) for details.
ITERATIONS_DEFAULT_VALUE - Static variable in interface opennlp.tools.util.Parameters
The default number of iterations is 100.
ITERATIONS_PARAM - Static variable in interface opennlp.tools.util.Parameters
 

K

KEEP_EQUAL - Enum constant in enum class opennlp.tools.document.Document.DuplicateLayerPolicy
Keep one copy of a layer key present on both documents when the two layers are structurally equal, for example when two parallel branches ran the same tokenizer.
key(String, Class) - Static method in class opennlp.tools.document.Layers
Creates a positional key in the toolkit's opennlp: namespace, for a layer the toolkit itself produces.

L

l1norm(double[]) - Static method in class opennlp.tools.ml.ArrayMath
Computes the L1-norm for a vector v.
l2norm(double[]) - Static method in class opennlp.tools.ml.ArrayMath
Computes the L2-norm for a vector v.
labelGaps(Stack) - Method in interface opennlp.tools.parser.GapLabeler
Labels constituents found in the stack with gap labels if appropriate.
language() - Method in record class opennlp.tools.langdetect.LanguageSample
Returns the value of the language record component.
Language - Class in opennlp.tools.langdetect
Class for holding the document language and its confidence
Language(String) - Constructor for class opennlp.tools.langdetect.Language
 
Language(String, double) - Constructor for class opennlp.tools.langdetect.Language
 
LanguageCodeValidator - Class in opennlp.tools.util
Validates language codes against ISO 639 standards.
LanguageDetector - Interface in opennlp.tools.langdetect
The interface for LanguageDetector which predicts the Language for a context.
LanguageDetectorContextGenerator - Interface in opennlp.tools.langdetect
A context generator interface for LanguageDetector.
LanguageDetectorEvaluationMonitor - Interface in opennlp.tools.langdetect
A marker interface for evaluating language detectors.
LanguageModel - Interface in opennlp.tools.languagemodel
A language model can calculate the probability p (between 0 and 1) of a certain sequence of tokens, given its underlying vocabulary.
LanguageParams - Interface in opennlp.tools.cmdline.params
 
LanguageSample - Record Class in opennlp.tools.langdetect
Holds a classified document and its Language.
LanguageSample(Language, CharSequence) - Constructor for record class opennlp.tools.langdetect.LanguageSample
Instantiates a LanguageSample.
LayerKey<T> - Class in opennlp.tools.document
Identifies one annotation layer of a Document and carries the type of that layer's annotation values, so reading a layer back is statically typed.
LayerKey.Scope - Enum Class in opennlp.tools.document
How the annotations of a layer relate to the document text.
layers() - Method in interface opennlp.tools.document.Document
 
Layers - Class in opennlp.tools.document
The standard layer keys for the results the toolkit produces itself.
LEGACY - Enum constant in enum class opennlp.tools.util.CompatibilityMode
The output of OpenNLP 1.x/2.x.
LEGACY - Enum constant in enum class opennlp.tools.util.WhitespaceMode
OpenNLP 1.x/2.x whitespace: the union of Character.isWhitespace(int) and the Unicode Zs category.
LemmaSample - Class in opennlp.tools.lemmatizer
Represents a lemmatized sentence.
LemmaSample(String[], String[], String[]) - Constructor for class opennlp.tools.lemmatizer.LemmaSample
Initializes a LemmaSample instance with the given parameters.
LemmaSample(List, List, List) - Constructor for class opennlp.tools.lemmatizer.LemmaSample
Initializes a LemmaSample instance with the given parameters.
lemmatize(String[], String[]) - Method in interface opennlp.tools.lemmatizer.Lemmatizer
Generates lemmas for the word and postag.
lemmatize(List, List) - Method in interface opennlp.tools.lemmatizer.Lemmatizer
Generates lemma tags for the word and postag.
Lemmatizer - Interface in opennlp.tools.lemmatizer
The common interface for lemmatizers.
LEMMATIZER - Enum constant in enum class opennlp.tools.models.ModelType
 
LemmatizerContextGenerator - Interface in opennlp.tools.lemmatizer
Interface for the context generator used for probabilistic Lemmatizer.
LemmatizerEvaluationMonitor - Interface in opennlp.tools.lemmatizer
A marker interface for evaluating lemmatizers.
length() - Method in class opennlp.tools.util.Span
 
levenshteinDistance(String, String) - Static method in class opennlp.tools.util.StringUtil
Computes the Levenshtein distance of two strings in a matrix.
LINE_BREAK - Enum constant in enum class opennlp.tools.util.normalizer.UnicodeWhitespace.Breaking
A forced line or paragraph break (e.g.
LINE_FEED - Static variable in class opennlp.tools.util.normalizer.UnicodeWhitespace
U+000A LINE FEED, a line break on its own or the second half of CRLF.
lineBreakCodePointSet() - Static method in class opennlp.tools.util.normalizer.UnicodeWhitespace
Returns the CodePointSet of whitespace characters that force a line or paragraph break.
lineBreaks() - Static method in class opennlp.tools.util.normalizer.UnicodeWhitespace
Returns the whitespace characters that force a line or paragraph break.
LinkedSpan<T> - Class in opennlp.tools.entitylinker
A default, extended Span that holds additional information about a Span.
LinkedSpan(ArrayList, int, int) - Constructor for class opennlp.tools.entitylinker.LinkedSpan
Initializes a new LinkedSpan.
LinkedSpan(ArrayList, int, int, String) - Constructor for class opennlp.tools.entitylinker.LinkedSpan
Initializes a new LinkedSpan.
LinkedSpan(ArrayList, int, int, String, double) - Constructor for class opennlp.tools.entitylinker.LinkedSpan
Initializes a new LinkedSpan.
LinkedSpan(ArrayList, Span, int) - Constructor for class opennlp.tools.entitylinker.LinkedSpan
Initializes a new LinkedSpan via an existing Span which is shifted by the specified offset.
loadExtensionClass(Class, String) - Static method in class opennlp.tools.util.ext.ExtensionLoader
Resolves the class with the given name as a subtype of clazz without instantiating it.
location() - Method in class opennlp.tools.util.ext.ProviderSpec
 
locationEndsWith(String) - Method in class opennlp.tools.util.ext.ProviderSpec
Checks whether the last path segment of the location ends with a suffix, ignoring case.
LOG_LIKELIHOOD - Enum constant in enum class opennlp.tools.monitoring.TrainingMeasure
 
logPrior(double[], int[]) - Method in interface opennlp.tools.ml.model.Prior
Populates the specified array with the log of the distribution for the specified context.
logPrior(double[], int[], float[]) - Method in interface opennlp.tools.ml.model.Prior
Populates the specified array with the log of the distribution for the specified context.
logPrior(double[], Context[], float[]) - Method in interface opennlp.tools.ml.model.Prior
Populates the specified array with the log of the distribution for the specified context.
logSumOfExps(double[]) - Static method in class opennlp.tools.ml.ArrayMath
Computes \log(\sum_{i=1}^n e^{x_i}) using a maximum-element trick to avoid arithmetic overflow.
lookalikes() - Static method in class opennlp.tools.util.normalizer.UnicodeWhitespace
Returns the related, non-whitespace look-alike format characters.

M

mathematical() - Static method in class opennlp.tools.util.normalizer.UnicodeDash
Returns the mathematical minus signs, excluded from the default normalization set.
max(double[]) - Static method in class opennlp.tools.ml.ArrayMath
Finds the maximum element in a vector x.
MAX_ENTRIES - Static variable in class opennlp.tools.util.ResourceLimits
Upper bound on count fields and resource sizes that drive allocations (matrix dimensions, lexicon entries, model outcome counts, and similar).
MAX_ENTRIES_PROPERTY - Static variable in class opennlp.tools.util.ResourceLimits
System property for overriding ResourceLimits.MAX_ENTRIES.
MAX_MATRIX_CELLS - Static variable in class opennlp.tools.util.ResourceLimits
Upper bound on the cell count of a two-dimensional cost table, whose entries are far smaller than the record-sized entries ResourceLimits.MAX_ENTRIES bounds.
MAX_MATRIX_CELLS_PROPERTY - Static variable in class opennlp.tools.util.ResourceLimits
System property for overriding ResourceLimits.MAX_MATRIX_CELLS.
MAXENT - Enum constant in enum class opennlp.tools.ml.AlgorithmType
 
MAXENT - Enum constant in enum class opennlp.tools.util.model.ModelType
 
MAXENT_QN - Enum constant in enum class opennlp.tools.ml.AlgorithmType
 
MaxentModel - Interface in opennlp.tools.ml.model
Interface for maximum entropy models.
MAY_BREAK - Enum constant in enum class opennlp.tools.util.normalizer.UnicodeWhitespace.Breaking
A break opportunity, but not a forced line break (e.g.
mean() - Method in class opennlp.tools.util.eval.Mean
 
Mean - Class in opennlp.tools.util.eval
Calculates the arithmetic mean of values added with the Mean.add(double) method.
Mean() - Constructor for class opennlp.tools.util.eval.Mean
 
members() - Method in class opennlp.tools.util.normalizer.CharClass
Returns the member code points of this class.
merge(Document) - Method in interface opennlp.tools.document.Document
Returns a document combining this document's layers with another document's layers over the same text, joining documents grown independently, for example by pipelines that ran in parallel.
merge(Document, Document.DuplicateLayerPolicy) - Method in interface opennlp.tools.document.Document
Returns a document combining this document's layers with another document's layers over the same text, resolving duplicate layer keys with duplicateLayers.
MERGE_BOTH - Enum constant in enum class opennlp.tools.tokenize.Detokenizer.DetokenizationOperation
The current token should be attached to the string on the left side, as well as to the start token on the right side.
MERGE_TO_LEFT - Enum constant in enum class opennlp.tools.tokenize.Detokenizer.DetokenizationOperation
The current token should be attached to the string on the left side.
MERGE_TO_RIGHT - Enum constant in enum class opennlp.tools.tokenize.Detokenizer.DetokenizationOperation
The current token should be attached to the start token on the right side.
mergeInto(FMeasure) - Method in class opennlp.tools.util.eval.FMeasure
Merge results into metric.
misclassified(T, T) - Method in interface opennlp.tools.util.eval.EvaluationMonitor
 
MODE_PROPERTY - Static variable in enum class opennlp.tools.util.CompatibilityMode
System property that selects the active CompatibilityMode at startup.
MODE_PROPERTY - Static variable in enum class opennlp.tools.util.WhitespaceMode
System property that selects the active WhitespaceMode at startup.
model() - Method in record class opennlp.tools.models.ClassPathModelEntry
Returns the value of the model record component.
ModelType - Enum Class in opennlp.tools.models
A model type to pattern enumeration.
ModelType - Enum Class in opennlp.tools.util.model
Enumeration of supported model types.
MutableTagDictionary - Interface in opennlp.tools.postag
Interface that allows TagDictionary entries to be added and removed.

N

NAIVE_BAYES - Enum constant in enum class opennlp.tools.ml.AlgorithmType
 
name() - Method in interface opennlp.tools.util.ext.Provider
 
name() - Method in record class opennlp.tools.util.normalizer.UnicodeDash.DashCharacter
Returns the value of the name record component.
name() - Method in record class opennlp.tools.util.normalizer.UnicodeWhitespace.RelatedCharacter
Returns the value of the name record component.
name() - Method in record class opennlp.tools.util.normalizer.UnicodeWhitespace.WhitespaceCharacter
Returns the value of the name record component.
NAME_FINDER - Enum constant in enum class opennlp.tools.models.ModelType
 
NameContextGenerator - Interface in opennlp.tools.namefind
Interface for generating the context for a name finder by specifying a set of feature generators.
NameSample - Class in opennlp.tools.namefind
Encapsulates names for a single unit of text.
NameSample(String[], Span[], boolean) - Constructor for class opennlp.tools.namefind.NameSample
Initializes a NameSample instance with given parameters.
NameSample(String[], Span[], String[][], boolean) - Constructor for class opennlp.tools.namefind.NameSample
Initializes a NameSample instance with given parameters.
NameSample(String, String[], Span[], String[][], boolean) - Constructor for class opennlp.tools.namefind.NameSample
Initializes a NameSample instance with given parameters.
newInstance(boolean) - Static method in class opennlp.tools.tokenize.WhitespaceTokenizer
Creates a tokenizer that is not shared with WhitespaceTokenizer.INSTANCE, for a caller that sets AbstractTokenizer.setKeepNewLines(boolean) without touching other users of the shared instance.
newStemmer() - Method in interface opennlp.tools.stemmer.StemmerFactory
Returns a new Stemmer.
next() - Method in class opennlp.tools.util.ReverseListIterator
 
nicePrint() - Method in class opennlp.tools.chunker.ChunkSample
Creates a nice to read string for the phrases formatted as following:
[NP Rockwell_NNP ] [VP said_VBD ] [NP the_DT agreement_NN ] [VP calls_VBZ ] [SBAR for_IN ] [NP it_PRP ] [VP to_TO supply_VB ] [NP 200_CD additional_JJ so-called_JJ shipsets_NNS ] [PP for_IN ] [NP the_DT planes_NNS ] ._.
NO_OPERATION - Enum constant in enum class opennlp.tools.tokenize.Detokenizer.DetokenizationOperation
Do not perform a merge operation for this token, but is possible that another token can be attached to the left or right side of this one.
NON_BREAKING - Enum constant in enum class opennlp.tools.util.normalizer.UnicodeWhitespace.Breaking
A space that suppresses line breaking (e.g.
nonBreaking() - Static method in class opennlp.tools.util.normalizer.UnicodeWhitespace
Returns the non-breaking whitespace characters.
normalize(CharSequence) - Method in class opennlp.tools.util.normalizer.CharClass
Replaces each member code point with the replacement, one for one.
normalize(CharSequence) - Method in interface opennlp.tools.util.normalizer.CharSequenceNormalizer
Normalizes a sequence of characters.
normalizeAligned(CharSequence) - Method in class opennlp.tools.util.normalizer.CharClass
Like CharClass.normalize(CharSequence) but also produces the Alignment back to the original text.
normalizeAligned(CharSequence) - Method in interface opennlp.tools.util.normalizer.OffsetAwareNormalizer
Normalizes text and returns the result together with the Alignment back to the input.
normalized() - Method in record class opennlp.tools.util.normalizer.AlignedText
Returns the value of the normalized record component.
normalizedLength() - Method in class opennlp.tools.util.normalizer.Alignment
Returns the length of the normalized text this alignment was built for.
normalizedString() - Method in record class opennlp.tools.util.normalizer.AlignedText
Returns the normalized text as a String, that is normalized().toString().
note() - Method in record class opennlp.tools.util.normalizer.UnicodeWhitespace.RelatedCharacter
Returns the value of the note record component.

O

ObjectStream<T> - Interface in opennlp.tools.util
Reads objects from a stream.
ObjectStreamFactory<T,P> - Interface in opennlp.tools.cmdline
 
ObjectStreamUtils - Class in opennlp.tools.util
 
ObjectStreamUtils() - Constructor for class opennlp.tools.util.ObjectStreamUtils
 
of(int...) - Static method in class opennlp.tools.util.normalizer.CodePointSet
Creates a set from explicit code points.
of(int[], String[]) - Static method in class opennlp.tools.depparse.DependencyTree
Creates a DependencyTree from parallel head and relation arrays.
of(CharSequence) - Static method in interface opennlp.tools.document.Document
Creates an empty Document over a text.
of(Class) - Static method in class opennlp.tools.util.ext.Providers
Looks the providers of an SPI up with the thread context class loader, or with the class loader of spi if the thread has none or if it cannot see spi.
of(Class, ClassLoader) - Static method in class opennlp.tools.util.ext.Providers
Looks the providers of an SPI up with a class loader.
of(Class, ClassLoader, UnaryOperator) - Static method in class opennlp.tools.util.ext.Providers
Looks the providers of an SPI up with a class loader and reads the configuration keys from an application's own source instead of "META-INF/opennlp/providers.properties"<P extends Provider<?>> and the system properties.
of(Class, ClassLoader, UnaryOperator, Predicate) - Static method in class opennlp.tools.util.ext.Providers
of(String, Class) - Static method in class opennlp.tools.document.LayerKey
Creates a LayerKey.
of(URI) - Static method in class opennlp.tools.util.ext.ProviderSpec
Creates a spec with a location and without options.
of(URI, Map) - Static method in class opennlp.tools.util.ext.ProviderSpec
Creates a spec with a location and options.
of(Path) - Static method in class opennlp.tools.util.ext.ProviderSpec
Creates a spec for a file or directory without options, see ProviderSpec.of(Path, Map).
of(Path, Map) - Static method in class opennlp.tools.util.ext.ProviderSpec
Creates a spec for a file or directory with options.
of(Map) - Static method in class opennlp.tools.util.ext.ProviderSpec
Creates a spec with options and without location.
of(CodePointSet, int) - Static method in class opennlp.tools.util.normalizer.CharClass
Creates a class from a member set and a replacement code point.
of(T) - Static method in record class opennlp.tools.document.Annotation
Creates a span-less annotation for a document-scoped layer.
OffsetAwareNormalizer - Interface in opennlp.tools.util.normalizer
A CharSequenceNormalizer that can additionally report the Alignment from its normalized output back to the input, so a span found in the normalized text maps to the exact character offsets of the original.
OffsetMappingNameFinder - Interface in opennlp.tools.namefind
A TokenNameFinder that can additionally report detected spans in the character coordinates of the original input, mapping back through any text normalization applied before detection.
ofRange(int, int) - Static method in class opennlp.tools.util.normalizer.CodePointSet
Creates a set covering an inclusive code point range.
ofTrusted(Class, ClassLoader, Predicate) - Static method in class opennlp.tools.util.ext.Providers
Looks the providers of an SPI up with a class loader, using only the provider classes a predicate accepts, which lets an application decide by the code source, the module or the signers of a class instead of by its name.
OPENNLP_MODEL_JAR_PREFIX - Static variable in interface opennlp.tools.models.ClassPathModelFinder
 
opennlp.tools.chunker - package opennlp.tools.chunker
 
opennlp.tools.cmdline - package opennlp.tools.cmdline
 
opennlp.tools.cmdline.params - package opennlp.tools.cmdline.params
 
opennlp.tools.commons - package opennlp.tools.commons
 
opennlp.tools.depparse - package opennlp.tools.depparse
 
opennlp.tools.doccat - package opennlp.tools.doccat
 
opennlp.tools.document - package opennlp.tools.document
 
opennlp.tools.embeddings - package opennlp.tools.embeddings
 
opennlp.tools.entitylinker - package opennlp.tools.entitylinker
 
opennlp.tools.langdetect - package opennlp.tools.langdetect
 
opennlp.tools.languagemodel - package opennlp.tools.languagemodel
 
opennlp.tools.lemmatizer - package opennlp.tools.lemmatizer
 
opennlp.tools.ml - package opennlp.tools.ml
 
opennlp.tools.ml.model - package opennlp.tools.ml.model
 
opennlp.tools.models - package opennlp.tools.models
 
opennlp.tools.monitoring - package opennlp.tools.monitoring
 
opennlp.tools.namefind - package opennlp.tools.namefind
 
opennlp.tools.parser - package opennlp.tools.parser
 
opennlp.tools.postag - package opennlp.tools.postag
 
opennlp.tools.sentdetect - package opennlp.tools.sentdetect
 
opennlp.tools.sentiment - package opennlp.tools.sentiment
 
opennlp.tools.stemmer - package opennlp.tools.stemmer
 
opennlp.tools.stopword - package opennlp.tools.stopword
 
opennlp.tools.termvector - package opennlp.tools.termvector
 
opennlp.tools.tokenize - package opennlp.tools.tokenize
 
opennlp.tools.util - package opennlp.tools.util
 
opennlp.tools.util.eval - package opennlp.tools.util.eval
 
opennlp.tools.util.ext - package opennlp.tools.util.ext
 
opennlp.tools.util.featuregen - package opennlp.tools.util.featuregen
 
opennlp.tools.util.java - package opennlp.tools.util.java
 
opennlp.tools.util.jvm - package opennlp.tools.util.jvm
 
opennlp.tools.util.model - package opennlp.tools.util.model
 
opennlp.tools.util.normalizer - package opennlp.tools.util.normalizer
 
opennlp.tools.util.wordvector - package opennlp.tools.util.wordvector
 
option(String, String) - Method in class opennlp.tools.util.ext.ProviderSpec
Reads an option.
options() - Method in class opennlp.tools.util.ext.ProviderSpec
 
ORDINAL_KEY - Static variable in class opennlp.tools.util.ext.Providers
The key that orders several "META-INF/opennlp/providers.properties"<P extends Provider<?>> files, 0 by default.
original() - Method in record class opennlp.tools.util.normalizer.AlignedText
Returns the value of the original record component.
originalLength() - Method in class opennlp.tools.util.normalizer.Alignment
Returns the length of the original text this alignment was built for.

P

ParamChecks - Class in opennlp.tools.util
Argument checks that report an invalid parameter with an IllegalArgumentException naming that parameter.
Parameters - Interface in opennlp.tools.util
 
parse(String) - Static method in enum class opennlp.tools.parser.ParserType
 
parse(String) - Static method in class opennlp.tools.postag.POSSample
Parses a sentenceString.
parse(String[], Class) - Static method in class opennlp.tools.cmdline.ArgumentParser
Parses the passed arguments and creates an instance of the proxy interface.
parse(String[], String[]) - Method in interface opennlp.tools.depparse.DependencyParser
Parses a sentence into a DependencyTree.
parse(String, boolean) - Static method in class opennlp.tools.namefind.NameSample
Parses given input into a NameSample.
parse(String, String) - Static method in class opennlp.tools.tokenize.TokenSample
Parses a string sample.
parse(String, String, boolean) - Static method in class opennlp.tools.namefind.NameSample
Parses given input into a NameSample.
parse(Parse) - Method in interface opennlp.tools.parser.Parser
Returns a Parse for the specified Parse of tokens.
parse(Parse, int) - Method in interface opennlp.tools.parser.Parser
Returns the specified number of parses or fewer for the specified tokens.
Parse - Class in opennlp.tools.parser
Data structure for holding parse constituents.
Parse(String, Span, String, double, int) - Constructor for class opennlp.tools.parser.Parse
Initializes a node for this specified text and span of the specified type with probability p and the head index.
Parse(String, Span, String, double, Parse) - Constructor for class opennlp.tools.parser.Parse
Initializes a node for this specified text and span of the specified type with probability p and the head index.
parseCodePoint(CharSequence) - Static method in class opennlp.tools.util.normalizer.HexCodePoints
Parses hex digits as one code point.
parseCodePoint(CharSequence, int, int) - Static method in class opennlp.tools.util.normalizer.HexCodePoints
Parses the hex digits between two indexes as one code point.
parseParse(String) - Static method in class opennlp.tools.parser.Parse
Parses the specified tree-bank style parse string and return a Parse structure for that string.
parseParse(String, GapLabeler) - Static method in class opennlp.tools.parser.Parse
Parses the specified tree-bank style Parse string and return a Parse structure for that string.
Parser - Interface in opennlp.tools.parser
Defines common methods for full-syntactic parsers.
PARSER - Enum constant in enum class opennlp.tools.models.ModelType
 
parseRange(CharSequence) - Static method in class opennlp.tools.util.normalizer.HexCodePoints
Parses one code point or an inclusive XXXX..YYYY range.
ParserEvaluationMonitor - Interface in opennlp.tools.parser
A marker interface for evaluating parsers.
ParserEventTypeEnum - Enum Class in opennlp.tools.parser
Enumeration of event types for a Parser.
ParserType - Enum Class in opennlp.tools.parser
Enumeration of supported Parser types.
path() - Method in class opennlp.tools.util.ext.ProviderSpec
 
Pd - Enum constant in enum class opennlp.tools.util.normalizer.UnicodeDash.Category
Pd - dash punctuation.
PERCEPTRON - Enum constant in enum class opennlp.tools.ml.AlgorithmType
 
PERCEPTRON - Enum constant in enum class opennlp.tools.util.model.ModelType
 
PERCEPTRON_SEQUENCE - Enum constant in enum class opennlp.tools.ml.AlgorithmType
 
PERCEPTRON_SEQUENCE - Enum constant in enum class opennlp.tools.util.model.ModelType
 
phrasesAsSpanList(String[], String[], String[]) - Static method in class opennlp.tools.chunker.ChunkSample
Create arrays of spans of phrases.
piece() - Method in record class opennlp.tools.tokenize.SubwordPiece
Returns the value of the piece record component.
PlainTextByLineStream - Class in opennlp.tools.util
Reads a plain text file and returns each line as a String object.
PlainTextByLineStream(InputStreamFactory, String) - Constructor for class opennlp.tools.util.PlainTextByLineStream
Initializes a PlainTextByLineStream.
PlainTextByLineStream(InputStreamFactory, Charset) - Constructor for class opennlp.tools.util.PlainTextByLineStream
Initializes a PlainTextByLineStream.
Po - Enum constant in enum class opennlp.tools.util.normalizer.UnicodeDash.Category
Po - other punctuation (the swung dash).
POS - Enum constant in enum class opennlp.tools.models.ModelType
 
POS_GENERIC - Enum constant in enum class opennlp.tools.models.ModelType
 
POS_TAGS - Static variable in class opennlp.tools.document.Layers
Part-of-speech tags; one annotation per token, aligned with Layers.TOKENS by position, carrying the tag.
POSContextGenerator - Interface in opennlp.tools.postag
Interface for a BeamSearchContextGenerator used in POS tagging.
POSITIONAL - Enum constant in enum class opennlp.tools.document.LayerKey.Scope
Every annotation of the layer is anchored to a span of the text.
POSSample - Class in opennlp.tools.postag
Represents an pos-tagged sentence.
POSSample(String[], String[]) - Constructor for class opennlp.tools.postag.POSSample
Initializes a POSSample instance.
POSSample(String[], String[], String[][]) - Constructor for class opennlp.tools.postag.POSSample
Initializes a POSSample instance.
POSSample(List, List) - Constructor for class opennlp.tools.postag.POSSample
Initializes a POSSample instance.
POSSample(List, List, String[][]) - Constructor for class opennlp.tools.postag.POSSample
Initializes a POSSample instance.
POSTagger - Interface in opennlp.tools.postag
The interface for part of speech taggers.
POSTaggerEvaluationMonitor - Interface in opennlp.tools.postag
A marker interface for evaluating pos taggers.
precision(Object[], Object[]) - Static method in class opennlp.tools.util.eval.FMeasure
Calculates the precision score for the given reference and predicted spans.
predict(String) - Method in interface opennlp.tools.sentiment.SentimentDetector
Conducts a sentiment prediction for the specifed sentence.
predict(String[]) - Method in interface opennlp.tools.sentiment.SentimentDetector
Conducts a sentiment prediction for the specifed sentence.
predictLanguage(CharSequence) - Method in interface opennlp.tools.langdetect.LanguageDetector
Predicts the Language for the full content length.
predictLanguages(CharSequence) - Method in interface opennlp.tools.langdetect.LanguageDetector
Predicts the languages for the full content length.
predictNextTokens(String...) - Method in interface opennlp.tools.languagemodel.LanguageModel
Predict the most probable output sequence of tokens, given an input sequence of tokens.
Prior - Interface in opennlp.tools.ml.model
This interface allows one to implement a prior distribution for use in maximum entropy model training.
priority() - Method in interface opennlp.tools.util.ext.Provider
 
Probabilistic - Interface in opennlp.tools.ml
A marker interface for classes with probabilistic capabilities.
probs() - Method in interface opennlp.tools.ml.Probabilistic
Retrieves the probabilities of the last decoded sequence.
progMon() - Method in record class opennlp.tools.util.TrainingConfiguration
Returns the value of the progMon record component.
properties() - Method in record class opennlp.tools.models.ClassPathModelEntry
Returns the value of the properties record component.
Provider<T> - Interface in opennlp.tools.util.ext
Creates instances of one service interface from a ProviderSpec.
ProviderResolutionException - Exception Class in opennlp.tools.util.ext
Thrown if Providers cannot resolve exactly one provider.
ProviderResolutionException(String) - Constructor for exception class opennlp.tools.util.ext.ProviderResolutionException
Initializes the exception.
ProviderResolutionException(String, Throwable) - Constructor for exception class opennlp.tools.util.ext.ProviderResolutionException
Initializes the exception.
Providers<P> - Class in opennlp.tools.util.ext
Resolves the providers of one SPI.
ProviderSpec - Class in opennlp.tools.util.ext
Describes what a Provider should create: an optional location, such as a model file, and string options.
provides() - Method in interface opennlp.tools.document.DocumentAnnotator
 
pruneParse(Parse) - Static method in class opennlp.tools.parser.Parse
Prune the specified sentence parse of vacuous productions.
put(String, boolean) - Method in interface opennlp.tools.util.Parameters
Puts a value into the current Parameters under a certain key.
put(String, double) - Method in interface opennlp.tools.util.Parameters
Puts a value into the current Parameters under a certain key.
put(String, int) - Method in interface opennlp.tools.util.Parameters
Puts a value into the current Parameters under a certain key.
put(String, String) - Method in interface opennlp.tools.util.Parameters
Puts a value into the current Parameters under a certain key.
put(String, String...) - Method in interface opennlp.tools.postag.MutableTagDictionary
Associates the specified tags with the specified word.
put(String, String, boolean) - Method in interface opennlp.tools.util.Parameters
Puts a value into the current Parameters under a certain key.
put(String, String, double) - Method in interface opennlp.tools.util.Parameters
Puts a value into the current Parameters under a certain key.
put(String, String, int) - Method in interface opennlp.tools.util.Parameters
Puts a value into the current Parameters under a certain key.
put(String, String, String) - Method in interface opennlp.tools.util.Parameters
Puts a value into the current Parameters under a certain key.
putIfAbsent(String, boolean) - Method in interface opennlp.tools.util.Parameters
Puts a value into the current Parameters under a certain key, if the value was not present before.
putIfAbsent(String, double) - Method in interface opennlp.tools.util.Parameters
Puts a value into the current Parameters under a certain key, if the value was not present before.
putIfAbsent(String, int) - Method in interface opennlp.tools.util.Parameters
Puts a value into the current Parameters under a certain key, if the value was not present before.
putIfAbsent(String, String) - Method in interface opennlp.tools.util.Parameters
Puts a value into the current Parameters under a certain key, if the value was not present before.
putIfAbsent(String, String, boolean) - Method in interface opennlp.tools.util.Parameters
Puts a value into the current Parameters under a certain key, if the value was not present before.
putIfAbsent(String, String, double) - Method in interface opennlp.tools.util.Parameters
Puts a value into the current Parameters under a certain key, if the value was not present before.
putIfAbsent(String, String, int) - Method in interface opennlp.tools.util.Parameters
Puts a value into the current Parameters under a certain key, if the value was not present before.
putIfAbsent(String, String, String) - Method in interface opennlp.tools.util.Parameters
Puts a value into the current Parameters under a certain key, if the value was not present before.

R

read() - Method in class opennlp.tools.util.AbstractObjectStream
 
read() - Method in interface opennlp.tools.util.ObjectStream
Returns the next T object.
read() - Method in class opennlp.tools.util.PlainTextByLineStream
 
readDouble() - Method in interface opennlp.tools.ml.model.DataReader
 
readInt() - Method in interface opennlp.tools.ml.model.DataReader
 
readUTF() - Method in interface opennlp.tools.ml.model.DataReader
 
recall(Object[], Object[]) - Static method in class opennlp.tools.util.eval.FMeasure
Calculates the recall score for the given reference and predicted spans.
registerAllowedPackage(String) - Static method in class opennlp.tools.util.ext.ExtensionLoader
Registers an additional package prefix whose classes are permitted to be loaded as OpenNLP extensions.
REJECT - Enum constant in enum class opennlp.tools.document.Document.DuplicateLayerPolicy
Reject any layer key present on both documents.
RelatedCharacter(int, String, String, String) - Constructor for record class opennlp.tools.util.normalizer.UnicodeWhitespace.RelatedCharacter
Creates an instance of a RelatedCharacter record class.
relation() - Method in record class opennlp.tools.depparse.DependencyArc
Returns the value of the relation record component.
relationOf(int) - Method in class opennlp.tools.depparse.DependencyTree
Retrieves the relation label of a token.
remove() - Method in class opennlp.tools.util.ReverseListIterator
 
remove(int) - Method in class opennlp.tools.parser.Parse
 
removeAll(CharSequence) - Method in class opennlp.tools.util.normalizer.CharClass
Removes every member code point.
removeAllAligned(CharSequence) - Method in class opennlp.tools.util.normalizer.CharClass
Like CharClass.removeAll(CharSequence) but also produces the Alignment back to the original text.
replace(int, int) - Method in class opennlp.tools.util.normalizer.Alignment.Builder
Records a rewritten block: originalCount original characters that produced normalizedCount normalized characters.
replacement() - Method in class opennlp.tools.util.normalizer.CharClass
Returns the canonical replacement code point.
requireAligned(Document, LayerKey, LayerKey) - Static method in class opennlp.tools.document.DocumentAnnotators
Verifies that two layers of a document hold the same number of annotations, so the annotation at each position of one belongs to the annotation at the same position of the other.
requireFinite(double, String) - Static method in class opennlp.tools.util.ParamChecks
Returns value if it is finite.
requireLayers(Document, LayerKey...) - Static method in class opennlp.tools.document.DocumentAnnotators
Verifies that a document is present and carries every given layer.
requireNonBlank(String, String) - Static method in class opennlp.tools.util.ParamChecks
Returns value if it is neither null nor blank.
requireNonEmpty(T, String) - Static method in class opennlp.tools.util.ParamChecks
Returns value if it is neither null nor empty.
requireNonEmpty(T, String) - Static method in class opennlp.tools.util.ParamChecks
Returns value if it is neither null nor empty.
requireNonEmptyParallelArrays(Object[], String, Object[], String) - Static method in class opennlp.tools.util.ParamChecks
Checks two arrays that hold corresponding values.
requireNonNegative(double, String) - Static method in class opennlp.tools.util.ParamChecks
Returns value if it is not negative.
requireNonNegative(int, String) - Static method in class opennlp.tools.util.ParamChecks
Returns value if it is not negative.
requireNonNegative(long, String) - Static method in class opennlp.tools.util.ParamChecks
Returns value if it is not negative.
requireNonNullArg(T, String) - Static method in class opennlp.tools.util.ParamChecks
Returns value if it is not null.
requirePositive(double, String) - Static method in class opennlp.tools.util.ParamChecks
Returns value if it is greater than zero.
requirePositive(int, String) - Static method in class opennlp.tools.util.ParamChecks
Returns value if it is greater than zero.
requirePositiveFraction(double, String) - Static method in class opennlp.tools.util.ParamChecks
Returns value if it is in (0, 1].
requires() - Method in interface opennlp.tools.document.DocumentAnnotator
 
requireWithinMaxEntries(long, String) - Static method in class opennlp.tools.util.ResourceLimits
Checks a count read from a resource against ResourceLimits.MAX_ENTRIES.
requireWithinMaxEntries(long, String, Function) - Static method in class opennlp.tools.util.ResourceLimits
Checks a count read from a resource against ResourceLimits.MAX_ENTRIES and reports a violation through an exception of the caller's choice.
reset() - Method in class opennlp.tools.util.AbstractObjectStream
 
reset() - Static method in enum class opennlp.tools.util.CompatibilityMode
Discards any override set via CompatibilityMode.setActive(CompatibilityMode) and re-resolves the active mode from the "opennlp.compat.mode" system property.
reset() - Method in interface opennlp.tools.util.ObjectStream
Repositions the stream at the beginning and the previously seen object sequence will be repeated exactly.
reset() - Method in class opennlp.tools.util.PlainTextByLineStream
Repositions the stream at the beginning and the previously seen object sequence will be repeated exactly.
reset() - Method in interface opennlp.tools.util.ResetableIterator
Sets the Iterator back to the first retrieved element.
reset() - Static method in enum class opennlp.tools.util.WhitespaceMode
Discards any override set via WhitespaceMode.setActive(WhitespaceMode) and re-resolves the active mode from the "opennlp.whitespace.mode" system property.
ResetableIterator<E> - Interface in opennlp.tools.util
This interface makes an Iterator resettable.
ResourceLimits - Class in opennlp.tools.util
Shared upper bounds for counts read from user-supplied resources, so a crafted file cannot force an outsized allocation before validation completes.
ReverseListIterator<T> - Class in opennlp.tools.util
An iterator for a list which returns values in the opposite order as the typical list iterator.
ReverseListIterator(List) - Constructor for class opennlp.tools.util.ReverseListIterator
 
ROBERTA_CLS_TOKEN - Static variable in class opennlp.tools.tokenize.WordpieceTokenizer
RoBERTa classification token: <s>.
ROBERTA_SEP_TOKEN - Static variable in class opennlp.tools.tokenize.WordpieceTokenizer
RoBERTa separator token.
ROBERTA_UNK_TOKEN - Static variable in class opennlp.tools.tokenize.WordpieceTokenizer
RoBERTa unknown token.
root() - Method in class opennlp.tools.depparse.DependencyTree
 
ROOT_HEAD - Static variable in record class opennlp.tools.depparse.DependencyArc
The head value marking an arc from the artificial root node.

S

Sample - Interface in opennlp.tools.commons
Represents a generic type of processable elements.
scope() - Method in class opennlp.tools.document.LayerKey
 
scoreMap(String[]) - Method in interface opennlp.tools.doccat.DocumentCategorizer
Retrieves a Map in which the key is the category name and the value is the score.
SDContextGenerator - Interface in opennlp.tools.sentdetect
Interface for SentenceDetector context generators.
select(ProviderSpec) - Method in class opennlp.tools.util.ext.Providers
Resolves the provider for a spec.
sentDetect(CharSequence) - Method in interface opennlp.tools.sentdetect.SentenceDetector
Detects sentences in a character sequence.
SENTENCE_DETECTOR - Enum constant in enum class opennlp.tools.models.ModelType
 
SentenceDetector - Interface in opennlp.tools.sentdetect
The interface for sentence detectors, which find the sentence boundaries in a text.
SentenceDetectorEvaluationMonitor - Interface in opennlp.tools.sentdetect
 
SENTENCES - Static variable in class opennlp.tools.document.Layers
Sentence boundaries; each annotation covers one sentence and carries its text.
SentenceSample - Class in opennlp.tools.sentdetect
A SentenceSample contains a document with begin indexes of the individual sentences.
SentenceSample(CharSequence, Span...) - Constructor for class opennlp.tools.sentdetect.SentenceSample
Initializes the current instance.
SentenceSample(Detokenizer, String[][]) - Constructor for class opennlp.tools.sentdetect.SentenceSample
 
SentimentDetector - Interface in opennlp.tools.sentiment
 
SentimentEvaluationMonitor - Interface in opennlp.tools.sentiment
An sentiment specific EvaluationMonitor to be used by the evaluator.
SentimentSample - Class in opennlp.tools.sentiment
Class for holding text used for sentiment analysis.
SentimentSample(String, String[]) - Constructor for class opennlp.tools.sentiment.SentimentSample
Instantiates a SentimentSample object.
SentimentSample(String, String[], boolean) - Constructor for class opennlp.tools.sentiment.SentimentSample
 
sentPosDetect(CharSequence) - Method in interface opennlp.tools.sentdetect.SentenceDetector
Detects sentences in a character sequence.
Sequence<T> - Class in opennlp.tools.ml.model
Class which models a sequence.
Sequence - Class in opennlp.tools.util
Represents a weighted sequence of outcomes.
Sequence() - Constructor for class opennlp.tools.util.Sequence
Initializes a new Sequence of outcomes.
Sequence(List) - Constructor for class opennlp.tools.util.Sequence
Initializes a new Sequence of outcomes from a list of outcomes.
Sequence(Event[], T) - Constructor for class opennlp.tools.ml.model.Sequence
Initializes Sequence made up of the specified events and derived from the specified source.
Sequence(Sequence) - Constructor for class opennlp.tools.util.Sequence
Initializes a new Sequence of outcomes from an existing Sequence.
Sequence(Sequence, String, double) - Constructor for class opennlp.tools.util.Sequence
Initializes a new Sequence of outcomes from an existing Sequence.
SEQUENCE_VALUE - Static variable in interface opennlp.tools.ml.EventModelSequenceTrainer
 
SEQUENCE_VALUE - Static variable in interface opennlp.tools.ml.SequenceTrainer
 
SequenceClassificationModel - Interface in opennlp.tools.ml.model
A classification model that can label an input Sequence.
SequenceCodec<T> - Interface in opennlp.tools.util
A codec for sequences of type T.
SequenceStream<S> - Interface in opennlp.tools.ml.model
Interface for streams of sequences used to train sequence models.
SequenceTrainer<P> - Interface in opennlp.tools.ml
 
SequenceValidator<T> - Interface in opennlp.tools.util
 
SerializableArtifact - Interface in opennlp.tools.util.model
A marker interface so that implementing classes can refer to the corresponding ArtifactSerializer implementation.
serialize(OutputStream) - Method in interface opennlp.tools.util.Parameters
Serializes a Parameters instance via a specified OutputStream.
serialize(T, OutputStream) - Method in interface opennlp.tools.util.model.ArtifactSerializer
Serializes an artifact to the provided OutputStream.
setActive(CompatibilityMode) - Static method in enum class opennlp.tools.util.CompatibilityMode
Overrides the active CompatibilityMode for the whole process, taking precedence over the "opennlp.compat.mode" system property.
setActive(WhitespaceMode) - Static method in enum class opennlp.tools.util.WhitespaceMode
Overrides the active WhitespaceMode for the whole process, taking precedence over the "opennlp.whitespace.mode" system property.
setChild(int, String) - Method in class opennlp.tools.parser.Parse
Replaces the child at the specified index with a new child with the specified label.
setDerivation(StringBuffer) - Method in class opennlp.tools.parser.Parse
Specifies the derivation string to be associated with this parse.
setItemID(String) - Method in class opennlp.tools.entitylinker.BaseLink
 
setItemName(String) - Method in class opennlp.tools.entitylinker.BaseLink
 
setItemParentID(String) - Method in class opennlp.tools.entitylinker.BaseLink
 
setItemType(String) - Method in class opennlp.tools.entitylinker.BaseLink
 
setKeepNewLines(boolean) - Method in class opennlp.tools.tokenize.WhitespaceTokenizer
Switches whether to keep new lines or not.
setLabel(String) - Method in class opennlp.tools.parser.Constituent
Assigns the label to the constituent.
setLabel(String) - Method in class opennlp.tools.parser.Parse
Assigns this parse the specified label.
setLabels(String[], String[]) - Method in interface opennlp.tools.ml.model.Prior
Method to specify the label for the outcomes and contexts.
setLinkedEntries(ArrayList) - Method in class opennlp.tools.entitylinker.LinkedSpan
 
setNextPunctuation(Collection) - Method in class opennlp.tools.parser.Parse
Sets the punctuation tags which follow this parse.
setParent(Parse) - Method in class opennlp.tools.parser.Parse
Specifies the parent parse node for this constituent.
setPrevPunctuation(Collection) - Method in class opennlp.tools.parser.Parse
Sets the punctuation tags which precede this parse.
setScoreMap(Map) - Method in class opennlp.tools.entitylinker.BaseLink
 
setSearchTerm(String) - Method in class opennlp.tools.entitylinker.LinkedSpan
 
setSentenceid(int) - Method in class opennlp.tools.entitylinker.LinkedSpan
 
setType(String) - Method in class opennlp.tools.parser.Parse
Set the type of this constituent to the specified type.
show() - Method in class opennlp.tools.parser.Parse
Prints this parse using Penn Treebank-style formatting.
show(StringBuffer) - Method in class opennlp.tools.parser.Parse
Fills the specified StringBuffer with a string representation of this parse.
showCodeTree() - Method in class opennlp.tools.parser.Parse
Prints to standard out a representation of the specified parse which contains hash codes so that parent/child relationships can be explicitly seen.
since() - Element in annotation interface opennlp.tools.commons.Internal
The OpenNLP release when an element was first declared internal.
since() - Element in annotation interface opennlp.tools.commons.ThreadSafe
The OpenNLP release when an element was first declared thread-safe.
size() - Method in class opennlp.tools.depparse.DependencyTree
 
size() - Method in class opennlp.tools.util.normalizer.CodePointSet
Returns the number of code points in this set.
size() - Method in interface opennlp.tools.util.wordvector.WordVectorTable
 
Sm - Enum constant in enum class opennlp.tools.util.normalizer.UnicodeDash.Category
Sm - math symbol (the minus signs).
sortedScoreMap(String[]) - Method in interface opennlp.tools.doccat.DocumentCategorizer
Retrieves a SortedMap of the scores sorted in ascending order, together with their associated categories.
SPACE - Static variable in class opennlp.tools.util.normalizer.UnicodeWhitespace
The canonical ASCII whitespace that whitespace is normalized to: U+0020 SPACE.
span() - Method in record class opennlp.tools.document.Annotation
Returns the value of the span record component.
Span - Class in opennlp.tools.util
Class for storing start and end integer offsets.
Span(int, int) - Constructor for class opennlp.tools.util.Span
Initializes a new Span.
Span(int, int, double) - Constructor for class opennlp.tools.util.Span
Initializes a new Span.
Span(int, int, String) - Constructor for class opennlp.tools.util.Span
Initializes a new Span.
Span(int, int, String, double) - Constructor for class opennlp.tools.util.Span
Initializes a new Span.
Span(Span, double) - Constructor for class opennlp.tools.util.Span
Creates a new immutable Span based on an existing Span, where the existing Span did not include the probability.
Span(Span, int) - Constructor for class opennlp.tools.util.Span
Initializes a new Span with an existing Span which is shifted by an offset.
spans() - Method in record class opennlp.tools.termvector.TermVector
Returns the value of the spans record component.
spansToStrings(Span[], CharSequence) - Static method in class opennlp.tools.util.Span
Converts an array of spans to an array of String.
spansToStrings(Span[], String[]) - Static method in class opennlp.tools.util.Span
 
split(CharSequence) - Method in class opennlp.tools.util.normalizer.CharClass
Splits text into the maximal runs of non-member code points.
split(CharSequence, char) - Static method in class opennlp.tools.util.StringUtil
Splits input around literal occurrences of separator, with the same result as String.split(String) called with the single-character pattern Character.toString(separator) and a limit of 0: leading and middle empty fields are kept, trailing empty fields are removed, and empty input yields an array containing one empty string.
split(CharSequence, char, int) - Static method in class opennlp.tools.util.StringUtil
Splits input around literal occurrences of separator, with the same limit contract as String.split(String, int) applied to the single-character pattern Character.toString(separator): a positive limit applies at most limit - 1 splits and keeps trailing empty fields; 0 applies unlimited splits and removes trailing empty fields, exactly like StringUtil.split(CharSequence, char); a negative limit applies unlimited splits and keeps trailing empty fields.
splitNonEmpty(CharSequence, char...) - Static method in class opennlp.tools.util.StringUtil
Splits input around literal occurrences of any of the separators and drops the empty fields that leading, trailing or adjacent separators would produce, so a run of separators acts as one and input made only of separators yields an empty array.
splitOnUnicodeWhitespace(CharSequence) - Static method in class opennlp.tools.util.StringUtil
Splits input on runs of Unicode White_Space.
splitOnWhitespace(CharSequence) - Static method in class opennlp.tools.util.StringUtil
Splits input on runs of whitespace under the active WhitespaceMode, see StringUtil.isWhitespace(char).
splitSpans(CharSequence) - Method in class opennlp.tools.util.normalizer.CharClass
Splits text into the maximal runs of non-member code points, as character spans into the original text.
start() - Method in record class opennlp.tools.tokenize.SubwordPiece
Returns the value of the start record component.
START_TAG - Static variable in class opennlp.tools.namefind.NameSample
 
START_TAG_PREFIX - Static variable in class opennlp.tools.namefind.NameSample
 
startsWith(Span) - Method in class opennlp.tools.util.Span
 
startsWithByteOrderMark(CharSequence) - Static method in class opennlp.tools.util.StringUtil
Tests whether input starts with a byte order mark, U+FEFF, which a UTF-8 or UTF-16 text file may carry as its first character.
stem(CharSequence) - Method in interface opennlp.tools.stemmer.Stemmer
Stems word.
stemAll(CharSequence) - Method in interface opennlp.tools.stemmer.Stemmer
Returns all stem forms for word.
Stemmer - Interface in opennlp.tools.stemmer
Reduces a word to its root form.
StemmerFactory - Interface in opennlp.tools.stemmer
A factory that captures a stemmer configuration and creates configured Stemmer instances on demand.
stopCriteria() - Method in record class opennlp.tools.util.TrainingConfiguration
Returns the value of the stopCriteria record component.
StopCriteria<T> - Interface in opennlp.tools.monitoring
Stop criteria for model training.
StopwordFilter - Interface in opennlp.tools.stopword
A pluggable filter that decides whether a token (or a sequence of tokens) is a stopword that should be removed during downstream text processing.
stopwords() - Method in interface opennlp.tools.stopword.StopwordFilter
Returns an unmodifiable snapshot of the registered single-token stopwords.
StringInterner - Interface in opennlp.tools.util.jvm
A marker-interface for a String interner implementation.
StringUtil - Class in opennlp.tools.util
 
StringUtil() - Constructor for class opennlp.tools.util.StringUtil
 
stripByteOrderMark(String) - Static method in class opennlp.tools.util.StringUtil
Removes one leading byte order mark, U+FEFF, from input.
stripComment(String) - Static method in class opennlp.tools.util.normalizer.HexCodePoints
Removes a trailing comment from a data file line.
substitute(CharSequence, IntFunction) - Static method in class opennlp.tools.util.normalizer.CharClass
Applies a per-code-point substitution: each code point for which substitution returns a non-null string is replaced by that string, and the rest are copied through.
substituteAligned(CharSequence, IntFunction) - Static method in class opennlp.tools.util.normalizer.CharClass
Like CharClass.substitute(CharSequence, IntFunction) but also produces the Alignment back to the original text.
SubwordPiece - Record Class in opennlp.tools.tokenize
One subword unit produced by a SubwordTokenizer, including the model representation and source range.
SubwordPiece(String, int, int, int) - Constructor for record class opennlp.tools.tokenize.SubwordPiece
Instantiates a SubwordPiece.
SubwordTokenizer - Interface in opennlp.tools.tokenize
Splits text into subword units from a fixed model vocabulary, reporting the model id and original-text span for each unit.
sumFeatures(Context[], float[], double[]) - Static method in class opennlp.tools.ml.ArrayMath
 
supporting(ProviderSpec) - Method in class opennlp.tools.util.ext.Providers
Lists the available providers that support a spec, without the disabled ones.
supports(ProviderSpec) - Method in interface opennlp.tools.util.ext.Provider
Checks whether this provider can create an instance for a spec, based on the spec alone.
SuppressForbidden - Annotation Interface in opennlp.tools.commons
Marks a member with a public contract that is a user-supplied regular expression, for example the patterns given to RegexNameFinder or the alphanumeric Pattern accepted by the tokenizer factories.

T

tag() - Method in record class opennlp.tools.util.TokenTag
Returns the value of the tag record component.
tag(String[]) - Method in interface opennlp.tools.postag.POSTagger
Assigns the sentence of tokens pos tags.
tag(String[], Object[]) - Method in interface opennlp.tools.postag.POSTagger
Assigns the sentence of tokens pos tags.
TAG - Enum constant in enum class opennlp.tools.parser.ParserEventTypeEnum
Deprecated.
TagDictionary - Interface in opennlp.tools.postag
Interface to determine which tags are valid for a particular word based on a tag dictionary.
term() - Method in record class opennlp.tools.termvector.TermVector
Returns the value of the term record component.
TerminateToolException - Exception Class in opennlp.tools.cmdline
Exception to terminate the execution of a command line tool.
TerminateToolException(int) - Constructor for exception class opennlp.tools.cmdline.TerminateToolException
 
TerminateToolException(int, String) - Constructor for exception class opennlp.tools.cmdline.TerminateToolException
 
TerminateToolException(int, String, Throwable) - Constructor for exception class opennlp.tools.cmdline.TerminateToolException
 
TermVector - Record Class in opennlp.tools.termvector
One entry of a term vector layer: a term, how often it occurs in the document, and where.
TermVector(String, int, List) - Constructor for record class opennlp.tools.termvector.TermVector
Validates the term vector and detaches the span list from the caller's input.
text() - Method in interface opennlp.tools.document.Document
 
TextEmbedder - Interface in opennlp.tools.embeddings
Encodes text into a fixed-length vector.
TextEmbedderProvider - Interface in opennlp.tools.embeddings
The SPI for TextEmbedder providers.
THREADS_PARAM - Static variable in interface opennlp.tools.util.Parameters
 
ThreadSafe - Annotation Interface in opennlp.tools.commons
Classes, fields, or methods annotated &#64;ThreadSafe are safe to use in multithreading contexts.
toArray() - Method in class opennlp.tools.util.normalizer.CodePointSet
Returns the member code points, in ascending order.
toCharacterSpan(List, int, int, Span, String) - Static method in class opennlp.tools.document.DocumentAnnotators
Maps a span over one sentence's tokens onto the character span those tokens cover.
toDoubleArray(List) - Static method in class opennlp.tools.ml.ArrayMath
Convert a list of Double objects into an array of primitive doubles.
toDoubleBuffer() - Method in interface opennlp.tools.util.wordvector.WordVector
 
toFloatBuffer() - Method in interface opennlp.tools.util.wordvector.WordVector
 
toIntArray(List) - Static method in class opennlp.tools.ml.ArrayMath
Convert a list of Integer objects into an array of primitive integers.
toIso6391(String) - Static method in class opennlp.tools.util.LanguageCodeValidator
Converts a three-letter ISO 639-2/3 code, terminologic ("nld") or bibliographic ("dut"), to its ISO 639-1 two-letter equivalent ("nl").
toIso6393(String) - Static method in class opennlp.tools.util.LanguageCodeValidator
Converts an ISO 639-1 two-letter code ("de") or an ISO 639-2 bibliographic code ("ger") to its ISO 639-2/3 three-letter equivalent ("deu").
TOK_NODE - Static variable in interface opennlp.tools.parser.Parser
The label for a token node.
token() - Method in record class opennlp.tools.util.TokenTag
Returns the value of the token record component.
TokenContextGenerator - Interface in opennlp.tools.tokenize
Interface for context generators required for tokenizer implementations.
tokenize(String) - Method in class opennlp.tools.tokenize.WhitespaceTokenizer
 
tokenize(String) - Method in interface opennlp.tools.tokenize.Tokenizer
Splits a string into its atomic parts.
tokenize(String) - Method in class opennlp.tools.tokenize.WordpieceTokenizer
Splits a string into its atomic parts.
tokenizePos(String) - Method in interface opennlp.tools.tokenize.Tokenizer
Finds the boundaries of atomic parts in a string.
tokenizePos(String) - Method in class opennlp.tools.tokenize.WhitespaceTokenizer
 
tokenizePos(String) - Method in class opennlp.tools.tokenize.WordpieceTokenizer
Not supported: wordpiece tokens (subwords, ## continuations and special tokens) have no faithful character spans in the original text.
Tokenizer - Interface in opennlp.tools.tokenize
The interface for tokenizers, which segment a string into its tokens.
TOKENIZER - Enum constant in enum class opennlp.tools.models.ModelType
 
TokenizerEvaluationMonitor - Interface in opennlp.tools.tokenize
A marker interface for evaluating tokenizers.
TokenNameFinder - Interface in opennlp.tools.namefind
The interface for name finders which provide name tags for a sequence of tokens.
TokenNameFinderEvaluationMonitor - Interface in opennlp.tools.namefind
A marker interface for evaluating name finders.
tokens() - Method in interface opennlp.tools.util.wordvector.WordVectorTable
 
TOKENS - Static variable in class opennlp.tools.document.Layers
Token boundaries; each annotation covers one token and carries its text.
TokenSample - Class in opennlp.tools.tokenize
A TokenSample is text with token spans.
TokenSample(String, Span[]) - Constructor for class opennlp.tools.tokenize.TokenSample
Initializes a instance.
TokenSample(Detokenizer, String[]) - Constructor for class opennlp.tools.tokenize.TokenSample
Initializes a instance via a Detokenizer.
TokenTag - Record Class in opennlp.tools.util
 
TokenTag(String, String, String[]) - Constructor for record class opennlp.tools.util.TokenTag
Creates an instance of a TokenTag record class.
toLowerCase(CharSequence) - Static method in class opennlp.tools.util.StringUtil
Converts a CharSequence to lower case, independent of the current Locale via Character.toLowerCase(int) which uses mapping information from the UnicodeData file.
toLowerCaseCharBuffer(CharSequence) - Static method in class opennlp.tools.util.StringUtil
 
toNormalizedSpan(int, int) - Method in record class opennlp.tools.util.normalizer.AlignedText
Maps a span of the original text forward to the normalized text.
toNormalizedSpan(int, int) - Method in class opennlp.tools.util.normalizer.Alignment
Maps a half-open span of the original text to the half-open span of the normalized text that covers it.
toOriginalOffset(int) - Method in class opennlp.tools.util.normalizer.Alignment
Maps a normalized offset to the original offset where its character begins (start semantics).
toOriginalSpan(int, int) - Method in record class opennlp.tools.util.normalizer.AlignedText
Maps a span of the normalized text back to the tightest span of the original text.
toOriginalSpan(int, int) - Method in class opennlp.tools.util.normalizer.Alignment
Maps a half-open span of the normalized text to the tightest half-open span of the original text that produced it.
TOP_NODE - Static variable in interface opennlp.tools.parser.Parser
The label for the top node.
topKSequences(String[]) - Method in interface opennlp.tools.postag.POSTagger
Assigns the sentence the top-k sequences.
topKSequences(String[], Object[]) - Method in interface opennlp.tools.postag.POSTagger
Assigns the sentence the top-k sequences.
topKSequences(String[], String[]) - Method in interface opennlp.tools.chunker.Chunker
Computes the top k chunk sequences for the specified sentence with the specified pos-tags.
topKSequences(String[], String[], double) - Method in interface opennlp.tools.chunker.Chunker
Computes the top k chunk sequences for the specified sentence with the specified pos-tags.
toString() - Method in class opennlp.tools.chunker.ChunkSample
 
toString() - Method in record class opennlp.tools.depparse.DependencyArc
Returns a string representation of this record class.
toString() - Method in class opennlp.tools.depparse.DependencySample
toString() - Method in class opennlp.tools.depparse.DependencyTree
toString() - Method in class opennlp.tools.doccat.DocumentSample
 
toString() - Method in record class opennlp.tools.document.Annotation
Returns a string representation of this record class.
toString() - Method in class opennlp.tools.document.LayerKey
toString() - Method in class opennlp.tools.entitylinker.BaseLink
 
toString() - Method in class opennlp.tools.entitylinker.LinkedSpan
 
toString() - Method in class opennlp.tools.langdetect.Language
 
toString() - Method in record class opennlp.tools.langdetect.LanguageSample
Returns a string representation of this record class.
toString() - Method in class opennlp.tools.lemmatizer.LemmaSample
 
toString() - Method in class opennlp.tools.ml.model.Event
 
toString() - Method in record class opennlp.tools.models.ClassPathModelEntry
Returns a string representation of this record class.
toString() - Method in class opennlp.tools.namefind.NameSample
 
toString() - Method in class opennlp.tools.parser.Parse
Represents this Parse in a human-readable way.
toString() - Method in class opennlp.tools.postag.POSSample
 
toString() - Method in class opennlp.tools.sentdetect.SentenceSample
 
toString() - Method in class opennlp.tools.sentiment.SentimentSample
 
toString() - Method in record class opennlp.tools.termvector.TermVector
Returns a string representation of this record class.
toString() - Method in record class opennlp.tools.tokenize.SubwordPiece
Returns a string representation of this record class.
toString() - Method in class opennlp.tools.tokenize.TokenSample
 
toString() - Method in class opennlp.tools.util.eval.FMeasure
 
toString() - Method in class opennlp.tools.util.eval.Mean
 
toString() - Method in class opennlp.tools.util.ext.ProviderSpec
The option values and the user info, query and fragment of the location are omitted, as they may hold credentials.
toString() - Method in record class opennlp.tools.util.normalizer.AlignedText
Returns a string representation of this record class.
toString() - Method in record class opennlp.tools.util.normalizer.UnicodeDash.DashCharacter
Returns a string representation of this record class.
toString() - Method in record class opennlp.tools.util.normalizer.UnicodeWhitespace.RelatedCharacter
Returns a string representation of this record class.
toString() - Method in record class opennlp.tools.util.normalizer.UnicodeWhitespace.WhitespaceCharacter
Returns a string representation of this record class.
toString() - Method in class opennlp.tools.util.Sequence
 
toString() - Method in class opennlp.tools.util.Span
 
toString() - Method in record class opennlp.tools.util.TokenTag
Returns a string representation of this record class.
toString() - Method in record class opennlp.tools.util.TrainingConfiguration
Returns a string representation of this record class.
toStringPennTreebank() - Method in class opennlp.tools.parser.Parse
 
toUnicodeNotation() - Method in record class opennlp.tools.util.normalizer.UnicodeDash.DashCharacter
Returns the U+XXXX notation for this code point.
toUnicodeNotation() - Method in record class opennlp.tools.util.normalizer.UnicodeWhitespace.RelatedCharacter
Returns the U+XXXX notation for this code point.
toUnicodeNotation() - Method in record class opennlp.tools.util.normalizer.UnicodeWhitespace.WhitespaceCharacter
Returns the U+XXXX notation for this code point.
toUpperCase(CharSequence) - Static method in class opennlp.tools.util.StringUtil
Converts a CharSequence to upper case, independent of the current Locale via Character.toUpperCase(int) which uses mapping information from the UnicodeData file.
train(DataIndexer) - Method in interface opennlp.tools.ml.EventTrainer
Trains a MaxentModel for given events.
train(SequenceStream) - Method in interface opennlp.tools.ml.EventModelSequenceTrainer
Trains a MaxentModel for given events.
train(SequenceStream) - Method in interface opennlp.tools.ml.SequenceTrainer
train(ObjectStream) - Method in interface opennlp.tools.ml.EventTrainer
Trains a MaxentModel for given events.
Trainer<P> - Interface in opennlp.tools.commons
Represents a common base for training implementations.
TRAINER_TYPE_PARAM - Static variable in interface opennlp.tools.util.Parameters
 
TrainingConfiguration - Record Class in opennlp.tools.util
Configuration used for model training.
TrainingConfiguration(TrainingProgressMonitor, StopCriteria) - Constructor for record class opennlp.tools.util.TrainingConfiguration
Creates an instance of a TrainingConfiguration record class.
TrainingMeasure - Enum Class in opennlp.tools.monitoring
Enumeration of Training measures.
TrainingProgressMonitor - Interface in opennlp.tools.monitoring
An interface to capture training progress of a model.
TrainingToolParams - Interface in opennlp.tools.cmdline.params
Common training parameters.
TREEINSERT - Enum constant in enum class opennlp.tools.parser.ParserType
 
trim(CharSequence) - Method in class opennlp.tools.util.normalizer.CharClass
Removes leading and trailing member code points.
trim(CharSequence) - Method in class opennlp.tools.util.Span
 
trimAligned(CharSequence) - Method in class opennlp.tools.util.normalizer.CharClass
Like CharClass.trim(CharSequence) but also produces the Alignment back to the original text.
trimUnicodeWhitespace(CharSequence) - Static method in class opennlp.tools.util.StringUtil
Trims leading and trailing runs of Unicode White_Space, the same set StringUtil.splitOnUnicodeWhitespace(CharSequence) breaks terms on.
type() - Method in class opennlp.tools.document.LayerKey
 

U

UNICODE - Enum constant in enum class opennlp.tools.util.WhitespaceMode
The Unicode White_Space property.
UnicodeDash - Class in opennlp.tools.util.normalizer
Reference data for Unicode dashes, plus O(1) membership lookups.
UnicodeDash.Category - Enum Class in opennlp.tools.util.normalizer
The Unicode general category of a dash code point.
UnicodeDash.DashCharacter - Record Class in opennlp.tools.util.normalizer
One Unicode dash code point and its reference attributes.
UnicodeWhitespace - Class in opennlp.tools.util.normalizer
Reference data for Unicode whitespace, plus O(1) membership lookups.
UnicodeWhitespace.Breaking - Enum Class in opennlp.tools.util.normalizer
Line-breaking behavior, mirroring the "Notes" column of the reference table.
UnicodeWhitespace.Category - Enum Class in opennlp.tools.util.normalizer
Unicode general category for a whitespace or related code point.
UnicodeWhitespace.RelatedCharacter - Record Class in opennlp.tools.util.normalizer
One related code point that is commonly confused with whitespace but is not (White_Space=no).
UnicodeWhitespace.WhitespaceCharacter - Record Class in opennlp.tools.util.normalizer
One Unicode whitespace code point and its reference attributes.
union(CodePointSet) - Method in class opennlp.tools.util.normalizer.CodePointSet
Returns a new set containing every code point in this set or other.
unregisterAllowedPackage(String) - Static method in class opennlp.tools.util.ext.ExtensionLoader
Removes a previously registered package prefix.
UnsatisfiedProviderException - Exception Class in opennlp.tools.util.ext
Thrown if no available provider supports a spec, or none of them has the configured name.
UnsatisfiedProviderException(String) - Constructor for exception class opennlp.tools.util.ext.UnsatisfiedProviderException
Initializes the exception.
updateAdaptiveData(String[], String[]) - Method in interface opennlp.tools.namefind.NameContextGenerator
Informs all the feature generators that the specified tokens have been classified with the corresponds set of specified outcomes.
updateAdaptiveData(String[], String[]) - Method in interface opennlp.tools.util.featuregen.AdaptiveFeatureGenerator
Informs a feature generator that the specified tokens have been classified with the corresponding set of specified outcomes.
updateContext(Sequence, MaxentModel) - Method in interface opennlp.tools.ml.model.SequenceStream
Creates a new event array based on the outcomes predicted by the specified parameters for the specified Sequence.
updateHeads(HeadRules) - Method in class opennlp.tools.parser.Parse
Computes the head parses for this parse and its sub-parses and stores this information in the parse data structure.
updateScores(Object[], Object[]) - Method in class opennlp.tools.util.eval.FMeasure
Updates the score based on the number of true positives and the number of predictions and references.
updateSpan() - Method in class opennlp.tools.parser.Parse
 
useFunctionTags(boolean) - Static method in class opennlp.tools.parser.Parse
Specifies whether function tags should be included as part of the constituent type.

V

validateArguments(String[], Class...) - Static method in class opennlp.tools.cmdline.ArgumentParser
Tests if the argument are correct or incorrect.
validateArguments(String[], Class) - Static method in class opennlp.tools.cmdline.ArgumentParser
Tests if the argument are correct or incorrect.
validateArgumentsLoudly(String[], Class) - Static method in class opennlp.tools.cmdline.ArgumentParser
Tests if the arguments are correct or incorrect.
validateArgumentsLoudly(String[], Class...) - Static method in class opennlp.tools.cmdline.ArgumentParser
Tests if the arguments are correct or incorrect.
validateLanguageCode(String) - Static method in class opennlp.tools.util.LanguageCodeValidator
Validates the given language code and throws an IllegalArgumentException if it is not a recognized ISO 639 language code.
validSequence(int, T[], String[], String) - Method in interface opennlp.tools.util.SequenceValidator
Determines whether a particular continuation of a sequence is valid.
value() - Element in annotation interface opennlp.tools.commons.Internal
 
value() - Element in annotation interface opennlp.tools.commons.SuppressForbidden
 
value() - Method in record class opennlp.tools.document.Annotation
Returns the value of the value record component.
valueName() - Element in annotation interface opennlp.tools.cmdline.ArgumentParser.ParameterDescription
 
valueOf(String) - Static method in enum class opennlp.tools.document.Document.DuplicateLayerPolicy
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class opennlp.tools.document.LayerKey.Scope
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class opennlp.tools.ml.AlgorithmType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class opennlp.tools.models.ModelType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class opennlp.tools.monitoring.TrainingMeasure
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class opennlp.tools.parser.ParserEventTypeEnum
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class opennlp.tools.parser.ParserType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class opennlp.tools.tokenize.Detokenizer.DetokenizationOperation
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class opennlp.tools.util.CompatibilityMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class opennlp.tools.util.model.ModelType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class opennlp.tools.util.normalizer.UnicodeDash.Category
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class opennlp.tools.util.normalizer.UnicodeWhitespace.Breaking
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class opennlp.tools.util.normalizer.UnicodeWhitespace.Category
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class opennlp.tools.util.WhitespaceMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class opennlp.tools.util.wordvector.WordVectorType
Returns the enum constant of this class with the specified name.
values() - Static method in enum class opennlp.tools.document.Document.DuplicateLayerPolicy
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class opennlp.tools.document.LayerKey.Scope
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class opennlp.tools.ml.AlgorithmType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class opennlp.tools.models.ModelType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class opennlp.tools.monitoring.TrainingMeasure
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class opennlp.tools.parser.ParserEventTypeEnum
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class opennlp.tools.parser.ParserType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class opennlp.tools.tokenize.Detokenizer.DetokenizationOperation
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class opennlp.tools.util.CompatibilityMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class opennlp.tools.util.model.ModelType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class opennlp.tools.util.normalizer.UnicodeDash.Category
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class opennlp.tools.util.normalizer.UnicodeWhitespace.Breaking
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class opennlp.tools.util.normalizer.UnicodeWhitespace.Category
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class opennlp.tools.util.WhitespaceMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class opennlp.tools.util.wordvector.WordVectorType
Returns an array containing the constants of this enum class, in the order they are declared.
values(List, int, int) - Static method in class opennlp.tools.document.DocumentAnnotators
Collects the values of a contiguous run of annotations, for example the tags of one sentence's tokens during DocumentAnnotators.forEachSentence(List, List, SentenceTokenConsumer).

W

whitespace() - Static method in class opennlp.tools.util.normalizer.CharClass
Returns the whitespace preset: the Unicode White_Space set, replacement U+0020.
WhitespaceCharacter(int, String, String, UnicodeWhitespace.Category, UnicodeWhitespace.Breaking) - Constructor for record class opennlp.tools.util.normalizer.UnicodeWhitespace.WhitespaceCharacter
Creates an instance of a WhitespaceCharacter record class.
WhitespaceMode - Enum Class in opennlp.tools.util
Selects the whitespace definition used by StringUtil.isWhitespace(char) and StringUtil.isWhitespace(int): the Unicode White_Space property, or OpenNLP's legacy definition from 1.x/2.x.
WhitespaceTokenizer - Class in opennlp.tools.tokenize
A basic Tokenizer implementation which performs tokenization using white spaces.
with(LayerKey, List) - Method in interface opennlp.tools.document.Document
Returns a new document with one layer added.
withAdditional(CodePointSet) - Method in class opennlp.tools.util.normalizer.CharClass
Returns a copy of this class whose member set is extended with extra (for example, user-defined code points loaded from CodePointSet.fromFile(Path, String)).
withSpans(String, List) - Static method in record class opennlp.tools.termvector.TermVector
Creates a full TermVector whose frequency is derived from the occurrence spans.
WordpieceEncoder - Class in opennlp.tools.tokenize
A SubwordTokenizer implementing the BERT tokenization stages: basic tokenization (control removal, whitespace normalization, CJK isolation, optional lower casing with accent stripping, punctuation isolation) followed by greedy longest-match wordpiece segmentation.
WordpieceEncoder(List) - Constructor for class opennlp.tools.tokenize.WordpieceEncoder
Instantiates an encoder for an uncased BERT model with the BERT special tokens.
WordpieceEncoder(List, boolean) - Constructor for class opennlp.tools.tokenize.WordpieceEncoder
Instantiates an encoder with the BERT special tokens.
WordpieceEncoder(List, boolean, int) - Constructor for class opennlp.tools.tokenize.WordpieceEncoder
Instantiates an encoder with the BERT special tokens and a custom word-length limit.
WordpieceEncoder(List, boolean, String, String, String) - Constructor for class opennlp.tools.tokenize.WordpieceEncoder
Instantiates an encoder with custom special tokens.
WordpieceEncoder(List, boolean, String, String, String, int) - Constructor for class opennlp.tools.tokenize.WordpieceEncoder
Instantiates an encoder with custom special tokens and a custom word-length limit.
WordpieceEncoder(Map, boolean, String, String, String) - Constructor for class opennlp.tools.tokenize.WordpieceEncoder
Instantiates an encoder from an explicit piece-to-id mapping for vocabularies with noncontiguous ids.
WordpieceEncoder(Map, boolean, String, String, String, int) - Constructor for class opennlp.tools.tokenize.WordpieceEncoder
Instantiates an encoder from a piece-to-id mapping with a custom word-length limit.
WordpieceTokenizer - Class in opennlp.tools.tokenize
A Tokenizer implementation which performs tokenization using word pieces.
WordpieceTokenizer(Set) - Constructor for class opennlp.tools.tokenize.WordpieceTokenizer
Initializes a WordpieceTokenizer with a vocabulary and a default maximum token length of 100 Unicode code points.
WordpieceTokenizer(Set, int) - Constructor for class opennlp.tools.tokenize.WordpieceTokenizer
Initializes a WordpieceTokenizer with a vocabulary and a custom maxTokenLength.
WordpieceTokenizer(Set, String, String, String) - Constructor for class opennlp.tools.tokenize.WordpieceTokenizer
Initializes a WordpieceTokenizer with a vocabulary and custom special tokens.
WordpieceTokenizer(Set, String, String, String, int) - Constructor for class opennlp.tools.tokenize.WordpieceTokenizer
Initializes a WordpieceTokenizer with a vocabulary, custom special tokens and a custom maxTokenLength.
WordVector - Interface in opennlp.tools.util.wordvector
A word vector.
WordVectorTable - Interface in opennlp.tools.util.wordvector
A table that maps tokens to word vectors.
WordVectorType - Enum Class in opennlp.tools.util.wordvector
 

Z

Zl - Enum constant in enum class opennlp.tools.util.normalizer.UnicodeWhitespace.Category
Zl - line separator.
Zp - Enum constant in enum class opennlp.tools.util.normalizer.UnicodeWhitespace.Category
Zp - paragraph separator.
Zs - Enum constant in enum class opennlp.tools.util.normalizer.UnicodeWhitespace.Category
Zs - space separator.
A B C D E F G H I K L M N O P R S T U V W Z 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form