Package org.apache.tika.parser.microsoft

Class ListManager

  • public class ListManager
extends AbstractListManager
    Computes the number text which goes at the beginning of each list paragraph

    Note: This class only handles the raw number text and does not apply any further formatting as described in [MS-DOC], v20140721, 2.4.6.3, Part 3 to it.

    Note 2: The tplc, a visual override for the appearance of list levels, as defined in [MS-DOC], v20140721, 2.9.328 is not taken care of in this class.

    Further, this class does not yet handle overrides

    • Constructor Summary

      Constructors 
      Constructor Description
      ListManager​(HWPFDocument document)
      Ordinary constructor for a new list reader

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getFormattedNumber​(Paragraph paragraph)
      Get the formatted number for a given paragraph

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ListManager

        public ListManager​(HWPFDocument document)
        Ordinary constructor for a new list reader
        Parameters:
        document - Document to process

    • Method Detail

      • getFormattedNumber

        public java.lang.String getFormattedNumber​(Paragraph paragraph)
        Get the formatted number for a given paragraph

        Note: This only works correctly if called subsequently for all paragraphs in a valid selection (main document, text field, ...) which are part of a list.

        Parameters:
        paragraph - list paragraph to process
        Returns:
        String which represents the numbering of this list paragraph; never null, can be empty string, though, if something goes wrong in getList()
        Throws:
        java.lang.IllegalArgumentException - If the given paragraph is null or is not part of a list