SimpleSpanFragmenter (Lucene 10.5.0 highlighter API)
Description: declaration: package: org.apache.lucene.search.highlight, class: SimpleSpanFragmenter

Package org.apache.lucene.search.highlight

# Class SimpleSpanFragmenter

java.lang.Object
org.apache.lucene.search.highlight.SimpleSpanFragmenter

All Implemented Interfaces:
  `Fragmenter`

public class SimpleSpanFragmenter extends Object implements Fragmenter
`Fragmenter` implementation which breaks text up into same-size fragments but does not split up `Spans`. This is a simple sample class.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `SimpleSpanFragmenter(QueryScorer queryScorer)`
  `SimpleSpanFragmenter(QueryScorer queryScorer, int fragmentSize)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `boolean`
  `isNewFragment()`
  Test to see if this token from the stream should be held in a new TextFragment.
  `void`
  `start(String originalText, TokenStream tokenStream)`
  Initializes the Fragmenter.

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### SimpleSpanFragmenter

    public SimpleSpanFragmenter(QueryScorer queryScorer)
    Parameters:
      `queryScorer` - QueryScorer that was used to score hits

  - ### SimpleSpanFragmenter

    public SimpleSpanFragmenter(QueryScorer queryScorer, int fragmentSize)
    Parameters:
      `queryScorer` - QueryScorer that was used to score hits
      `fragmentSize` - size in chars of each fragment

- ## Method Details

  - ### isNewFragment

    public boolean isNewFragment()
    Description copied from interface: `Fragmenter`
    Test to see if this token from the stream should be held in a new TextFragment. Every time this is called, the TokenStream passed to start(String, TokenStream) will have been incremented.
    Specified by:
      `isNewFragment` in interface `Fragmenter`

  - ### start

    public void start(String originalText, TokenStream tokenStream)
    Description copied from interface: `Fragmenter`
    Initializes the Fragmenter. You can grab references to the Attributes you are interested in from tokenStream and then access the values in `Fragmenter.isNewFragment()`.
    Specified by:
      `start` in interface `Fragmenter`
    Parameters:
      `originalText` - the original source text
      `tokenStream` - the `TokenStream` to be fragmented