org.crosswire.jsword.book.sword.processing

## Interface RawTextToXmlProcessor

- All Known Implementing Classes:
    NoOpRawTextProcessor

      public interface RawTextToXmlProcessor

  This interface declares operations to be carried out after Raw Text has been read from a backend, before it is returned as OSIS to the caller.
  Author:
    DM Smith
  See Also:
    `The GNU Lesser General Public License for details.`

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `init(List<org.jdom2.Content> partialDom)` Runs before the processing starts.
    `void` | `postVerse(Key verse, List<org.jdom2.Content> partialDom, String rawText)` Executes after a verse is read from the raw data.
    `void` | `preRange(VerseRange range, List<org.jdom2.Content> partialDom)` Executes before a range is read from the raw data.

- - ### Method Detail

    - #### init

          void init(List<org.jdom2.Content> partialDom)

      Runs before the processing starts.
      Parameters:
        `partialDom` - the DOM, empty at this stage

    - #### preRange

          void preRange(VerseRange range,
                      List<org.jdom2.Content> partialDom)

      Executes before a range is read from the raw data.
      Parameters:
        `range` - the verse that is currently being examined
        `partialDom` - the DOM that is being built up as data is read

    - #### postVerse

          void postVerse(Key verse,
                       List<org.jdom2.Content> partialDom,
                       String rawText)

      Executes after a verse is read from the raw data.
      Parameters:
        `verse` - the verse that is currently being examined
        `partialDom` - the DOM that is being built up as data is read
        `rawText` - the text that has been read, deciphered