# Index

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

## A

AbstractModelResource<T> - Class in opennlp.uima.util
  Base class provides access to a shared `resource`, eg. a model or dictionary.
AbstractModelResource() - Constructor for class opennlp.uima.util.AbstractModelResource
AbstractSentenceDetector - Class in opennlp.uima.sentdetect
AbstractSentenceDetector() - Constructor for class opennlp.uima.sentdetect.AbstractSentenceDetector
AbstractTokenizer - Class in opennlp.uima.tokenize
ADDITIONAL_TRAINING_DATA_ENCODING - Static variable in class opennlp.uima.util.UimaUtil
ADDITIONAL_TRAINING_DATA_FILE - Static variable in class opennlp.uima.util.UimaUtil
AnnotationComboIterator - Class in opennlp.uima.util
  UIMA Annotation iterator combination of super- and subiterator.
AnnotationComboIterator(CAS, Type, Type) - Constructor for class opennlp.uima.util.AnnotationComboIterator
  Create a new combo iterator.
AnnotationComparator - Class in opennlp.uima.util
  Checks two `annotations` for equality.
AnnotationComparator() - Constructor for class opennlp.uima.util.AnnotationComparator
AnnotationIteratorPair - Class in opennlp.uima.util
  A pair of a `UIMA annotation` and an `annotation iterator`.
AnnotationIteratorPair(AnnotationFS, Iterable<AnnotationFS>) - Constructor for class opennlp.uima.util.AnnotationIteratorPair
AnnotatorUtil - Class in opennlp.uima.util
  This is a utility class for Annotators.

## B

BEAM_SIZE_PARAMETER - Static variable in class opennlp.uima.util.UimaUtil
  The beam size parameter.

## C

CHILDREN_FEATURE_PARAMETER - Static variable in class opennlp.uima.parser.Parser
CHUNK_TAG_FEATURE_PARAMETER - Static variable in class opennlp.uima.chunker.Chunker
  The chunk tag feature parameter
CHUNK_TYPE_PARAMETER - Static variable in class opennlp.uima.chunker.Chunker
  The chunk type parameter.
Chunker - Class in opennlp.uima.chunker
  OpenNLP Chunker annotator.
Chunker() - Constructor for class opennlp.uima.chunker.Chunker
  Initializes a new instance.
ChunkerModelResource - Interface in opennlp.uima.chunker
ChunkerModelResourceImpl - Class in opennlp.uima.chunker
ChunkerModelResourceImpl() - Constructor for class opennlp.uima.chunker.ChunkerModelResourceImpl
compare(AnnotationFS, AnnotationFS) - Method in class opennlp.uima.util.AnnotationComparator
  Compares the start indexes of the annotations.
ContainingConstraint - Class in opennlp.uima.util
  Checks if an `AnnotationFS` is contained by the given AnnotationFS.
ContainingConstraint() - Constructor for class opennlp.uima.util.ContainingConstraint
  Initializes a `ContainingConstraint`.
ContainingConstraint(AnnotationFS) - Constructor for class opennlp.uima.util.ContainingConstraint
  Initializes a `ContainingConstraint`.
createOptionalDictionary(UimaContext, String) - Static method in class opennlp.uima.util.AnnotatorUtil
  Creates a `Dictionary` via the given `UimaContext`.
CUTOFF_PARAMETER - Static variable in class opennlp.uima.util.UimaUtil

## D

destroy() - Method in class opennlp.uima.chunker.Chunker
  Releases allocated resources.
destroy() - Method in class opennlp.uima.namefind.DictionaryNameFinder
  Releases allocated resources.
destroy() - Method in class opennlp.uima.namefind.NameFinder
  Releases allocated resources.
destroy() - Method in class opennlp.uima.parser.Parser
  Releases allocated resources.
destroy() - Method in class opennlp.uima.postag.POSTagger
  Releases allocated resources.
destroy() - Method in class opennlp.uima.sentdetect.SentenceDetector
  Releases allocated resources.
destroy() - Method in class opennlp.uima.tokenize.Tokenizer
  Releases allocated resources.
DICTIONARY_PARAMETER - Static variable in class opennlp.uima.util.UimaUtil
DictionaryNameFinder - Class in opennlp.uima.namefind
DictionaryNameFinder() - Constructor for class opennlp.uima.namefind.DictionaryNameFinder
  Initializes a new instance.
DictionaryResource - Interface in opennlp.uima.dictionary
DictionaryResourceImpl - Class in opennlp.uima.dictionary
DictionaryResourceImpl() - Constructor for class opennlp.uima.dictionary.DictionaryResourceImpl
DoccatModelResource - Interface in opennlp.uima.doccat
DoccatModelResourceImpl - Class in opennlp.uima.doccat
DoccatModelResourceImpl() - Constructor for class opennlp.uima.doccat.DoccatModelResourceImpl
DocumentCategorizer - Class in opennlp.uima.doccat
  A default implementation of an OpenNLP Document Categorizer.
DocumentCategorizer() - Constructor for class opennlp.uima.doccat.DocumentCategorizer

## E

ExceptionMessages - Class in opennlp.uima.util
  This class contains constants for the exception messages in the exception message catalog.
ExceptionMessages() - Constructor for class opennlp.uima.util.ExceptionMessages

## F

FEATURE_NOT_FOUND - Static variable in class opennlp.uima.util.ExceptionMessages

## G

get(StringList) - Method in class opennlp.uima.normalizer.StringDictionary
  Retrieves a value from a dictionary via its `key`.
getAnnotation() - Method in class opennlp.uima.util.AnnotationIteratorPair
getDictionary() - Method in interface opennlp.uima.dictionary.DictionaryResource
getDictionary() - Method in class opennlp.uima.dictionary.DictionaryResourceImpl
getModel() - Method in interface opennlp.uima.chunker.ChunkerModelResource
getModel() - Method in class opennlp.uima.chunker.ChunkerModelResourceImpl
getModel() - Method in interface opennlp.uima.doccat.DoccatModelResource
getModel() - Method in class opennlp.uima.doccat.DoccatModelResourceImpl
getModel() - Method in interface opennlp.uima.namefind.TokenNameFinderModelResource
getModel() - Method in class opennlp.uima.namefind.TokenNameFinderModelResourceImpl
getModel() - Method in interface opennlp.uima.parser.ParserModelResource
getModel() - Method in class opennlp.uima.parser.ParserModelResourceImpl
getModel() - Method in interface opennlp.uima.postag.POSModelResource
getModel() - Method in class opennlp.uima.postag.POSModelResourceImpl
getModel() - Method in interface opennlp.uima.sentdetect.SentenceModelResource
getModel() - Method in class opennlp.uima.sentdetect.SentenceModelResourceImpl
getModel() - Method in interface opennlp.uima.tokenize.TokenizerModelResource
  Retrieves the shared model instance.
getModel() - Method in class opennlp.uima.tokenize.TokenizerModelResourceImpl
getOptionalBooleanParameter(UimaContext, String) - Static method in class opennlp.uima.util.AnnotatorUtil
  Retrieves an optional parameter from the given `UimaContext`.
getOptionalFeature(Type, String, String) - Static method in class opennlp.uima.util.AnnotatorUtil
  Retrieves an optional `feature parameter` of specified type.
getOptionalFeatureParameter(UimaContext, Type, String, String) - Static method in class opennlp.uima.util.AnnotatorUtil
  Retrieves an optional `feature parameter` of specified type.
getOptionalFloatParameter(UimaContext, String) - Static method in class opennlp.uima.util.AnnotatorUtil
  Retrieves an optional parameter from the given `UimaContext`.
getOptionalIntegerParameter(UimaContext, String) - Static method in class opennlp.uima.util.AnnotatorUtil
  Retrieves an optional parameter from the given `UimaContext`.
getOptionalResourceAsStream(UimaContext, String) - Static method in class opennlp.uima.util.AnnotatorUtil
  Opens an `InputStream` for an optional resource via the given `UimaContext`.
getOptionalStringArrayParameter(UimaContext, String) - Static method in class opennlp.uima.util.AnnotatorUtil
  Retrieves an optional parameter array from the given `UimaContext`.
getOptionalStringParameter(UimaContext, String) - Static method in class opennlp.uima.util.AnnotatorUtil
  Retrieves an optional parameter from the given `UimaContext`.
getOptionalTypeParameter(UimaContext, TypeSystem, String) - Static method in class opennlp.uima.util.AnnotatorUtil
  Retrieves an optional `feature parameter` of specified type.
getRequiredBooleanParameter(UimaContext, String) - Static method in class opennlp.uima.util.AnnotatorUtil
  Retrieves a required parameter from the given context.
getRequiredFeature(Type, String) - Static method in class opennlp.uima.util.AnnotatorUtil
  Retrieves a `Feature` for a specified type and `featureName`, otherwise an exception is thrown.
getRequiredFeature(Type, String, String) - Static method in class opennlp.uima.util.AnnotatorUtil
  Retrieves a `Feature` of the given type.
getRequiredFeatureParameter(UimaContext, Type, String) - Static method in class opennlp.uima.util.AnnotatorUtil
  Retrieves a `feature parameter` of specified type.
getRequiredFeatureParameter(UimaContext, Type, String, String) - Static method in class opennlp.uima.util.AnnotatorUtil
  Retrieves a `feature parameter` of specified type.
getRequiredFloatParameter(UimaContext, String) - Static method in class opennlp.uima.util.AnnotatorUtil
  Retrieves a required parameter from the given context.
getRequiredIntegerParameter(UimaContext, String) - Static method in class opennlp.uima.util.AnnotatorUtil
  Retrieves a required parameter from the given context.
getRequiredStringParameter(UimaContext, String) - Static method in class opennlp.uima.util.AnnotatorUtil
  Retrieves a required parameter from the given context.
getRequiredTypeParameter(UimaContext, TypeSystem, String) - Static method in class opennlp.uima.util.AnnotatorUtil
  Retrieves a type of the given name from the given type system.
getResourceAsStream(UimaContext, String) - Static method in class opennlp.uima.util.AnnotatorUtil
  Opens an `InputStream` for a resource via the given `UimaContext`.
getSubIterator() - Method in class opennlp.uima.util.AnnotationIteratorPair
getType(TypeSystem, String) - Static method in class opennlp.uima.util.AnnotatorUtil
  Retrieves a type of the given name from the given type system.

## H

hasNext() - Method in class opennlp.uima.util.AnnotationComboIterator

## I

initialize() - Method in class opennlp.uima.namefind.DictionaryNameFinder
  Initializes the current instance with the given context.
initialize() - Method in class opennlp.uima.namefind.NameFinder
  Initializes the current instance with the given context.
initialize(UimaContext) - Method in class opennlp.uima.chunker.Chunker
  Initializes the current instance with the given context.
initialize(UimaContext) - Method in class opennlp.uima.doccat.LanguageDetector
initialize(UimaContext) - Method in class opennlp.uima.namefind.DictionaryNameFinder
initialize(UimaContext) - Method in class opennlp.uima.normalizer.Normalizer
  Initializes the current instance with the given `context`.
initialize(UimaContext) - Method in class opennlp.uima.parser.Parser
  Initializes the current instance with the given context.
initialize(UimaContext) - Method in class opennlp.uima.postag.POSTagger
  Initializes the current instance with the given context.
initialize(UimaContext) - Method in class opennlp.uima.sentdetect.AbstractSentenceDetector
initialize(UimaContext) - Method in class opennlp.uima.sentdetect.SentenceDetector
  Initializes the current instance with the given context.
initialize(UimaContext) - Method in class opennlp.uima.tokenize.AbstractTokenizer
initialize(UimaContext) - Method in class opennlp.uima.tokenize.Tokenizer
  Initializes the current instance with the given context.
INVALID_DICTIONARY_FORMAT - Static variable in class opennlp.uima.util.ExceptionMessages
IO_ERROR_DICTIONARY_READING - Static variable in class opennlp.uima.util.ExceptionMessages
IO_ERROR_MODEL_READING - Static variable in class opennlp.uima.util.ExceptionMessages
IS_REMOVE_EXISTINGS_ANNOTAIONS - Static variable in class opennlp.uima.util.UimaUtil
isLanguageSupported(String) - Static method in class opennlp.uima.normalizer.NumberUtil
  Checks if the language is supported.
ITERATIONS_PARAMETER - Static variable in class opennlp.uima.util.UimaUtil
iterator() - Method in class opennlp.uima.util.AnnotationComboIterator

## L

LANGUAGE_PARAMETER - Static variable in class opennlp.uima.util.UimaUtil
LanguageDetector - Class in opennlp.uima.doccat
  Analysis Engine (AE) which can detect the language of a text.
LanguageDetector() - Constructor for class opennlp.uima.doccat.LanguageDetector
load(DataResource) - Method in class opennlp.uima.util.AbstractModelResource
loadBytes(File) - Static method in class opennlp.uima.util.OpennlpUtil
  Loads data from a given `File`.
loadTrainingParams(String, boolean) - Static method in class opennlp.uima.util.OpennlpUtil
  Loads data from a given `File`.

## M

match(FeatureStructure) - Method in class opennlp.uima.util.ContainingConstraint
  Checks if the given `FeatureStructure` matches the constraint.
MESSAGE_CATALOG - Static variable in class opennlp.uima.util.ExceptionMessages
MODEL_PARAMETER - Static variable in class opennlp.uima.util.UimaUtil
  The model parameter.

## N

NAME_TYPE_MAP_PARAMETER - Static variable in class opennlp.uima.namefind.NameFinder
NAME_TYPE_PARAMETER - Static variable in class opennlp.uima.namefind.NameFinder
NameFinder - Class in opennlp.uima.namefind
  OpenNLP Name annotator.
NameFinder() - Constructor for class opennlp.uima.namefind.NameFinder
  Initializes a new instance.
next() - Method in class opennlp.uima.util.AnnotationComboIterator
Normalizer - Class in opennlp.uima.normalizer
  The Normalizer tries the structure annotations.
NumberUtil - Class in opennlp.uima.normalizer
  Provides methods to parse numbers which occur in natural language texts.
NumberUtil() - Constructor for class opennlp.uima.normalizer.NumberUtil

## O

opennlp.uima.chunker - package opennlp.uima.chunker
  Package related to finding non-recursive syntactic annotation such as noun phrase chunks.
opennlp.uima.dictionary - package opennlp.uima.dictionary
opennlp.uima.doccat - package opennlp.uima.doccat
opennlp.uima.namefind - package opennlp.uima.namefind
  Package related to finding proper names and numeric amounts.
opennlp.uima.normalizer - package opennlp.uima.normalizer
opennlp.uima.parser - package opennlp.uima.parser
opennlp.uima.postag - package opennlp.uima.postag
  Package related to part-of-speech tagging.
opennlp.uima.sentdetect - package opennlp.uima.sentdetect
  Package related to identifying sentence boundaries.
opennlp.uima.tokenize - package opennlp.uima.tokenize
  Package related to finding tokens or word segments.
opennlp.uima.util - package opennlp.uima.util
OpenNlpAnnotatorProcessException - Exception in opennlp.uima.util
OpenNlpAnnotatorProcessException(String, Object[]) - Constructor for exception opennlp.uima.util.OpenNlpAnnotatorProcessException
OpenNlpAnnotatorProcessException(String, Object[], Throwable) - Constructor for exception opennlp.uima.util.OpenNlpAnnotatorProcessException
OpenNlpAnnotatorProcessException(Throwable) - Constructor for exception opennlp.uima.util.OpenNlpAnnotatorProcessException
OpennlpUtil - Class in opennlp.uima.util
  This class contains util methods for the maxent library.

## P

PARAMETER_NOT_FOUND - Static variable in class opennlp.uima.util.ExceptionMessages
parse(String, String) - Static method in class opennlp.uima.normalizer.NumberUtil
  Parses a specified `number` for a certain `languageCode`.
PARSE_TYPE_PARAMETER - Static variable in class opennlp.uima.parser.Parser
Parser - Class in opennlp.uima.parser
  Abstract base class for OpenNLP Parser annotators.
Parser() - Constructor for class opennlp.uima.parser.Parser
ParserModelResource - Interface in opennlp.uima.parser
ParserModelResourceImpl - Class in opennlp.uima.parser
ParserModelResourceImpl() - Constructor for class opennlp.uima.parser.ParserModelResourceImpl
POS_FEATURE_PARAMETER - Static variable in class opennlp.uima.util.UimaUtil
  The pos feature parameter.
POSModelResource - Interface in opennlp.uima.postag
POSModelResourceImpl - Class in opennlp.uima.postag
POSModelResourceImpl() - Constructor for class opennlp.uima.postag.POSModelResourceImpl
POSTagger - Class in opennlp.uima.postag
  OpenNLP Part Of Speech annotator.
POSTagger() - Constructor for class opennlp.uima.postag.POSTagger
  Initializes a new instance.
PROBABILITY_FEATURE_PARAMETER - Static variable in class opennlp.uima.parser.Parser
PROBABILITY_FEATURE_PARAMETER - Static variable in class opennlp.uima.util.UimaUtil
process(CAS) - Method in class opennlp.uima.chunker.Chunker
  Performs chunking on the given `tcas` object.
process(CAS) - Method in class opennlp.uima.doccat.LanguageDetector
process(CAS) - Method in class opennlp.uima.namefind.DictionaryNameFinder
  Performs name finding on the given `CAS` object.
process(CAS) - Method in class opennlp.uima.normalizer.Normalizer
process(CAS) - Method in class opennlp.uima.parser.Parser
  Performs parsing on the given `CAS` object.
process(CAS) - Method in class opennlp.uima.postag.POSTagger
  Performs pos-tagging on the given tcas object.
process(CAS) - Method in class opennlp.uima.sentdetect.AbstractSentenceDetector
process(CAS) - Method in class opennlp.uima.tokenize.AbstractTokenizer
put(StringList, String) - Method in class opennlp.uima.normalizer.StringDictionary
  Adds a new entry to the dictionary.

## R

remove() - Method in class opennlp.uima.util.AnnotationComboIterator
  Not supported.
removeAnnotations(CAS, AnnotationFS, Type) - Static method in class opennlp.uima.util.UimaUtil
  Removes all annotations of type removeAnnotationType which are contained by annotations of type containerAnnotationType.

## S

SENTENCE_TYPE_PARAMETER - Static variable in class opennlp.uima.util.UimaUtil
  The sentence type parameter.
SentenceDetector - Class in opennlp.uima.sentdetect
  OpenNLP Sentence annotator.
SentenceDetector() - Constructor for class opennlp.uima.sentdetect.SentenceDetector
  Initializes a new instance.
SentenceModelResource - Interface in opennlp.uima.sentdetect
SentenceModelResourceImpl - Class in opennlp.uima.sentdetect
SentenceModelResourceImpl() - Constructor for class opennlp.uima.sentdetect.SentenceModelResourceImpl
serialize(OutputStream) - Method in class opennlp.uima.normalizer.StringDictionary
  Writes the dictionary to the given `OutputStream`.
serialize(BaseModel, File) - Static method in class opennlp.uima.util.OpennlpUtil
  Serializes a `GIS model` and writes it to the given `File`.
SimpleTokenizer - Class in opennlp.uima.tokenize
  OpenNLP Simple Tokenizer annotator.
SimpleTokenizer() - Constructor for class opennlp.uima.tokenize.SimpleTokenizer
  Initializes the current instance.
StringDictionary - Class in opennlp.uima.normalizer
StringDictionary() - Constructor for class opennlp.uima.normalizer.StringDictionary
StringDictionary(InputStream) - Constructor for class opennlp.uima.normalizer.StringDictionary
  Initializes `StringDictionary` via a specified `InputStream`.

## T

TOKEN_CLASS_FEATURE_NEXT_WINDOW_SIZE_PARAMETER - Static variable in class opennlp.uima.namefind.NameFinder
TOKEN_CLASS_FEATURE_PARAMETER - Static variable in class opennlp.uima.namefind.NameFinder
TOKEN_CLASS_FEATURE_PREV_WINDOW_SIZE_PARAMETER - Static variable in class opennlp.uima.namefind.NameFinder
TOKEN_FEATURE_NEXT_WINDOW_SIZE_PARAMETER - Static variable in class opennlp.uima.namefind.NameFinder
TOKEN_FEATURE_PARAMETER - Static variable in class opennlp.uima.namefind.NameFinder
TOKEN_FEATURE_PREV_WINDOW_SIZE_PARAMETER - Static variable in class opennlp.uima.namefind.NameFinder
TOKEN_PATTERN_OPTIMIZATION - Static variable in class opennlp.uima.namefind.NameFinder
TOKEN_TYPE_PARAMETER - Static variable in class opennlp.uima.util.UimaUtil
  The token type parameter.
Tokenizer - Class in opennlp.uima.tokenize
  OpenNLP Tokenizer annotator.
Tokenizer() - Constructor for class opennlp.uima.tokenize.Tokenizer
  Initializes a new instance.
TokenizerModelResource - Interface in opennlp.uima.tokenize
  A `TokenizerModel` which can be shared between `AnalysisEngine`s and loaded via the UIMA resource model.
TokenizerModelResourceImpl - Class in opennlp.uima.tokenize
TokenizerModelResourceImpl() - Constructor for class opennlp.uima.tokenize.TokenizerModelResourceImpl
TokenNameFinderModelResource - Interface in opennlp.uima.namefind
TokenNameFinderModelResourceImpl - Class in opennlp.uima.namefind
TokenNameFinderModelResourceImpl() - Constructor for class opennlp.uima.namefind.TokenNameFinderModelResourceImpl
TRAINING_PARAMS_FILE_PARAMETER - Static variable in class opennlp.uima.util.UimaUtil
TYPE_FEATURE_PARAMETER - Static variable in class opennlp.uima.parser.Parser
TYPE_NOT_FOUND - Static variable in class opennlp.uima.util.ExceptionMessages
typeSystemInit(TypeSystem) - Method in class opennlp.uima.chunker.Chunker
  Initializes the type system.
typeSystemInit(TypeSystem) - Method in class opennlp.uima.doccat.LanguageDetector
typeSystemInit(TypeSystem) - Method in class opennlp.uima.doccat.DocumentCategorizer
typeSystemInit(TypeSystem) - Method in class opennlp.uima.namefind.DictionaryNameFinder
  Initializes the `TypeSystem`.
typeSystemInit(TypeSystem) - Method in class opennlp.uima.namefind.NameFinder
  Initializes the type system.
typeSystemInit(TypeSystem) - Method in class opennlp.uima.normalizer.Normalizer
  Initializes the type system.
typeSystemInit(TypeSystem) - Method in class opennlp.uima.parser.Parser
  Initializes the type system.
typeSystemInit(TypeSystem) - Method in class opennlp.uima.postag.POSTagger
  Initializes the type system.
typeSystemInit(TypeSystem) - Method in class opennlp.uima.sentdetect.AbstractSentenceDetector
typeSystemInit(TypeSystem) - Method in class opennlp.uima.sentdetect.SentenceDetector
  Initializes the type system.
typeSystemInit(TypeSystem) - Method in class opennlp.uima.tokenize.AbstractTokenizer
typeSystemInit(TypeSystem) - Method in class opennlp.uima.tokenize.Tokenizer
  Initializes the type system.

## U

UimaUtil - Class in opennlp.uima.util
  This is a util class for uima operations.

## W

WhitespaceTokenizer - Class in opennlp.uima.tokenize
  OpenNLP Whitespace Tokenizer annotator.
WhitespaceTokenizer() - Constructor for class opennlp.uima.tokenize.WhitespaceTokenizer
  Initializes the current instance.
WRONG_FEATURE_TYPE - Static variable in class opennlp.uima.util.ExceptionMessages
WRONG_PARAMETER_TYPE - Static variable in class opennlp.uima.util.ExceptionMessages

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