# Uses of Class
opennlp.tools.util.Span

Packages that use Span
Package
Description
opennlp.tools.chunker
opennlp.tools.entitylinker
opennlp.tools.namefind
opennlp.tools.parser
opennlp.tools.sentdetect
opennlp.tools.tokenize
opennlp.tools.util

- ## Uses of Span in opennlp.tools.chunker

  Methods in opennlp.tools.chunker that return Span
  Modifier and Type
  Method
  Description
  `Span[]`
  Chunker.`chunkAsSpans(String[] toks, String[] tags)`
  Generates tagged chunk `spans` for the given sequence returning the result in a `span` array.
  `Span[]`
  ChunkSample.`getPhrasesAsSpanList()`
  `static Span[]`
  ChunkSample.`phrasesAsSpanList(String[] aSentence, String[] aTags, String[] aPreds)`
  Create arrays of `spans` of phrases.

- ## Uses of Span in opennlp.tools.entitylinker

  Classes in opennlp.tools.entitylinker with type parameters of type Span
  Modifier and Type
  Interface
  Description
  `interface`
  `EntityLinker<T extends Span>`
  EntityLinkers establish connections with external data to enrich extracted entities.
  Subclasses of Span in opennlp.tools.entitylinker
  Modifier and Type
  Class
  Description
  `class`
  `LinkedSpan<T extends BaseLink>`
  A default, extended `Span` that holds additional information about a `Span`.
  Methods in opennlp.tools.entitylinker with parameters of type Span
  Modifier and Type
  Method
  Description
  `List<T>`
  EntityLinker.`find(String doctext, Span[] sentences, Span[][] tokensBySentence, Span[][] namesBySentence)`
  Links an entire document of named entities to an external source.
  `List<T>`
  EntityLinker.`find(String doctext, Span[] sentences, Span[][] tokensBySentence, Span[][] namesBySentence, int sentenceIndex)`
  Links the names that correspond to the tokens[] spans.
  Constructors in opennlp.tools.entitylinker with parameters of type Span
  Modifier
  Constructor
  Description
  ``
  `LinkedSpan(ArrayList<T> linkedEntries, Span span, int offset)`
  Initializes a new `LinkedSpan` via an existing `Span` which is shifted by the specified `offset`.

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

  Methods in opennlp.tools.namefind that return Span
  Modifier and Type
  Method
  Description
  `Span[][]`
  DocumentNameFinder.`find(String[][] document)`
  Finds tokens `spans` for the specified document of sentences and their tokens.
  `Span[]`
  TokenNameFinder.`find(String[] tokens)`
  Generates name tags for the given sequence, typically a sentence, returning `token spans` for any identified names.
  `Span[]`
  NameSample.`getNames()`
  Constructors in opennlp.tools.namefind with parameters of type Span
  Modifier
  Constructor
  Description
  ``
  `NameSample(String[] sentence, Span[] names, boolean clearAdaptiveData)`
  Initializes a `NameSample` instance with given parameters.
  ``
  `NameSample(String[] sentence, Span[] names, String[][] additionalContext, boolean clearAdaptiveData)`
  Initializes a `NameSample` instance with given parameters.
  ``
  `NameSample(String id, String[] sentence, Span[] names, String[][] additionalContext, boolean clearAdaptiveData)`
  Initializes a `NameSample` instance with given parameters.

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

  Methods in opennlp.tools.parser that return Span
  Modifier and Type
  Method
  Description
  `Span`
  Constituent.`getSpan()`
  Returns the span of the constituent.
  `Span`
  Parse.`getSpan()`
  Methods in opennlp.tools.parser with parameters of type Span
  Modifier and Type
  Method
  Description
  `static void`
  Parse.`addNames(String tag, Span[] names, Parse[] tokens)`
  Utility method to insert named entities.
  Constructors in opennlp.tools.parser with parameters of type Span
  Modifier
  Constructor
  Description
  ``
  `Constituent(String label, Span span)`
  ``
  `Parse(String text, Span span, String type, double p, int index)`
  Initializes a `node` for this specified `text` and `span` of the specified `type` with probability `p` and the head `index`.
  ``
  `Parse(String text, Span span, String type, double p, Parse h)`
  Initializes a `node` for this specified `text` and `span` of the specified `type` with probability `p` and the head `index`.

- ## Uses of Span in opennlp.tools.sentdetect

  Methods in opennlp.tools.sentdetect that return Span
  Modifier and Type
  Method
  Description
  `Span[]`
  SentenceSample.`getSentences()`
  `Span[]`
  SentenceDetector.`sentPosDetect(CharSequence s)`
  Detects sentences in a character sequence.
  Constructors in opennlp.tools.sentdetect with parameters of type Span
  Modifier
  Constructor
  Description
  ``
  `SentenceSample(CharSequence document, Span... sentences)`
  Initializes the current instance.

- ## Uses of Span in opennlp.tools.tokenize

  Methods in opennlp.tools.tokenize that return Span
  Modifier and Type
  Method
  Description
  `Span[]`
  TokenSample.`getTokenSpans()`
  `Span[]`
  BertTokenizer.`tokenizePos(String text)`
  Not supported: wordpiece tokens (subwords, `##` continuations and special tokens) have no faithful character spans in the original text.
  `Span[]`
  Tokenizer.`tokenizePos(String s)`
  Finds the boundaries of atomic parts in a string.
  `Span[]`
  WhitespaceTokenizer.`tokenizePos(String d)`
  `Span[]`
  WordpieceTokenizer.`tokenizePos(String text)`
  Not supported: wordpiece tokens (subwords, `##` continuations and special tokens) have no faithful character spans in the original text.
  Constructors in opennlp.tools.tokenize with parameters of type Span
  Modifier
  Constructor
  Description
  ``
  `TokenSample(String text, Span[] tokenSpans)`
  Initializes a `instance`.

- ## Uses of Span in opennlp.tools.util

  Methods in opennlp.tools.util that return Span
  Modifier and Type
  Method
  Description
  `Span[]`
  SequenceCodec.`decode(List<T> c)`
  Decodes a sequence of `objects` into `Span` objects.
  `Span`
  Span.`trim(CharSequence text)`
  Methods in opennlp.tools.util with parameters of type Span
  Modifier and Type
  Method
  Description
  `int`
  Span.`compareTo(Span s)`
  Compares the specified `Span` to the current span.
  `boolean`
  Span.`contains(Span s)`
  Identical `spans` are considered to contain each other.
  `boolean`
  Span.`crosses(Span s)`
  Checks if the specified `Span` crosses this span.
  `T[]`
  SequenceCodec.`encode(Span[] names, int length)`
  Encodes `Span` objects into a sequence of `objects`.
  `boolean`
  Span.`intersects(Span s)`
  Checks if the specified `Span` intersects with this span.
  `static String[]`
  Span.`spansToStrings(Span[] spans, CharSequence s)`
  Converts an array of `spans` to an array of `String`.
  `static String[]`
  Span.`spansToStrings(Span[] spans, String[] tokens)`
  `boolean`
  Span.`startsWith(Span s)`
  Constructors in opennlp.tools.util with parameters of type Span
  Modifier
  Constructor
  Description
  ``
  `Span(Span span, double prob)`
  Creates a new immutable `Span` based on an existing `Span`, where the existing `Span` did not include the probability.
  ``
  `Span(Span span, int offset)`
  Initializes a new `Span` with an existing `Span` which is shifted by an offset.