Package org.docx4j.org.apache.poi.poifs.filesystem

Class OPOIFSDocument

java.lang.Object
org.docx4j.org.apache.poi.poifs.filesystem.OPOIFSDocument
All Implemented Interfaces:
POIFSViewable, BATManaged, BlockWritable
public final class OPOIFSDocument extends Object implements BATManaged, BlockWritable, POIFSViewable
This class manages a document in a old-style OPOIFS filesystem.

  • Field Details

  • Constructor Details

    • OPOIFSDocument

      public OPOIFSDocument(String name, RawDataBlock[] blocks, int length) throws IOException
      Constructor from large blocks
      Parameters:
      name - the name of the POIFSDocument
      blocks - the big blocks making up the POIFSDocument
      length - the actual length of the POIFSDocument
      Throws:
      IOException

    • OPOIFSDocument

      public OPOIFSDocument(String name, SmallDocumentBlock[] blocks, int length)
      Constructor from small blocks
      Parameters:
      name - the name of the POIFSDocument
      blocks - the small blocks making up the POIFSDocument
      length - the actual length of the POIFSDocument

    • OPOIFSDocument

      public OPOIFSDocument(String name, POIFSBigBlockSize bigBlockSize, ListManagedBlock[] blocks, int length) throws IOException
      Constructor from small blocks
      Parameters:
      name - the name of the POIFSDocument
      blocks - the small blocks making up the POIFSDocument
      length - the actual length of the POIFSDocument
      Throws:
      IOException

    • OPOIFSDocument

      public OPOIFSDocument(String name, ListManagedBlock[] blocks, int length) throws IOException
      Throws:
      IOException

    • OPOIFSDocument

      public OPOIFSDocument(String name, POIFSBigBlockSize bigBlockSize, InputStream stream) throws IOException
      Constructor
      Parameters:
      name - the name of the POIFSDocument
      stream - the InputStream we read data from
      Throws:
      IOException

    • OPOIFSDocument

      public OPOIFSDocument(String name, InputStream stream) throws IOException
      Throws:
      IOException

    • OPOIFSDocument

      public OPOIFSDocument(String name, int size, POIFSBigBlockSize bigBlockSize, POIFSDocumentPath path, POIFSWriterListener writer)
      Constructor
      Parameters:
      name - the name of the POIFSDocument
      size - the length of the POIFSDocument
      path - the path of the POIFSDocument
      writer - the writer who will eventually write the document contents

    • OPOIFSDocument

      public OPOIFSDocument(String name, int size, POIFSDocumentPath path, POIFSWriterListener writer)

  • Method Details

    • convertRawBlocksToBigBlocks

      private static DocumentBlock[] convertRawBlocksToBigBlocks(ListManagedBlock[] blocks) throws IOException
      Throws:
      IOException

    • convertRawBlocksToSmallBlocks

      private static SmallDocumentBlock[] convertRawBlocksToSmallBlocks(ListManagedBlock[] blocks)

    • getSmallBlocks

      public SmallDocumentBlock[] getSmallBlocks()
      Returns:
      array of SmallDocumentBlocks; may be empty, cannot be null

    • getSize

      public int getSize()
      Returns:
      size of the document

    • read

      void read(byte[] buffer, int offset)
      read data from the internal stores
      Parameters:
      buffer - the buffer to write to
      offset - the offset into our storage to read from This method is currently (Oct 2008) only used by test code. Perhaps it can be deleted

    • getDataInputBlock

      DataInputBlock getDataInputBlock(int offset)
      Returns:
      null if offset points to the end of the document stream

    • getDocumentProperty

      DocumentProperty getDocumentProperty()
      Returns:
      the instance's DocumentProperty

    • writeBlocks

      public void writeBlocks(OutputStream stream) throws IOException
      Write the storage to an OutputStream
      Specified by:
      writeBlocks in interface BlockWritable
      Parameters:
      stream - the OutputStream to which the stored data should be written
      Throws:
      IOException - on problems writing to the specified stream

    • countBlocks

      public int countBlocks()
      Return the number of BigBlock's this instance uses
      Specified by:
      countBlocks in interface BATManaged
      Returns:
      count of BigBlock instances

    • setStartBlock

      public void setStartBlock(int index)
      Set the start block for this instance
      Specified by:
      setStartBlock in interface BATManaged
      Parameters:
      index - index into the array of blocks making up the filesystem

    • getViewableArray

      public Object[] getViewableArray()
      Get an array of objects, some of which may implement POIFSViewable
      Specified by:
      getViewableArray in interface POIFSViewable
      Returns:
      an array of Object; may not be null, but may be empty

    • getViewableIterator

      public Iterator<Object> getViewableIterator()
      Get an Iterator of objects, some of which may implement POIFSViewable
      Specified by:
      getViewableIterator in interface POIFSViewable
      Returns:
      an Iterator; may not be null, but may have an empty back end store

    • preferArray

      public boolean preferArray()
      Give viewers a hint as to whether to call getViewableArray or getViewableIterator
      Specified by:
      preferArray in interface POIFSViewable
      Returns:
      true if a viewer should call getViewableArray, false if a viewer should call getViewableIterator

    • getShortDescription

      public String getShortDescription()
      Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents.
      Specified by:
      getShortDescription in interface POIFSViewable
      Returns:
      short description