Class FolderArchiveWriter

    • Constructor Summary

      Constructors 
      Constructor Description
      FolderArchiveWriter​(java.lang.String folderName)  
    • Constructor Detail

      • FolderArchiveWriter

        public FolderArchiveWriter​(java.lang.String folderName)
                            throws java.io.IOException
        Parameters:
        absolute - fileName the archive file name
        Throws:
        java.io.IOException
    • Method Detail

      • initialize

        public void initialize()
        Description copied from interface: IDocArchiveWriter
        This function must be called before the writer is used. initialize the document archive.
        Specified by:
        initialize in interface IDocArchiveWriter
      • createRandomAccessStream

        public RAOutputStream createRandomAccessStream​(java.lang.String relativePath)
                                                throws java.io.IOException
        Description copied from interface: IDocArchiveWriter
        Create a random access stream in the archive and return it.
        Specified by:
        createRandomAccessStream in interface IDocArchiveWriter
        Parameters:
        relativePath - - relative path to report archive path. The path is based on Unix syntax, with the root of the archive denoted by "/". The initial "/" character can be skipped.
        Returns:
        RAOutputStream
        Throws:
        java.io.IOException
      • dropStream

        public boolean dropStream​(java.lang.String relativePath)
        Delete a stream from the archive and make sure the stream has been closed.
        Specified by:
        dropStream in interface IDocArchiveWriter
        Parameters:
        relativePath - - the relative path of the stream
        Returns:
        whether the delete operation was successful
        Throws:
        java.io.IOException
      • getName

        public java.lang.String getName()
        Specified by:
        getName in interface IDocArchiveWriter
        Returns:
        the archive name
      • exists

        public boolean exists​(java.lang.String relativePath)
        Specified by:
        exists in interface IDocArchiveWriter
        Parameters:
        relativePath - - the relative stream path in the archive. The relative path is based on Unix syntax, with the root of the archive denoted by "/". The initial "/" character can be skipped.
        Returns:
        a list of strings representing the underlying stream names. The return values are in the relative path format too.
      • setStreamSorter

        public void setStreamSorter​(IStreamSorter streamSorter)
        Description copied from interface: IDocArchiveWriter
        Set the stream sorter (if needed). The stream sorter will be used to sort the streams. If no stream sorter is set, the streams will be written in random order.
        Specified by:
        setStreamSorter in interface IDocArchiveWriter
        Parameters:
        streamSorter - - the stream sorter
      • finish

        public void finish()
                    throws java.io.IOException
        Description copied from interface: IDocArchiveWriter
        This function must be called after the writer is used. finalizes the socument archive. This may involve compressing the archive to a single file. This also closes and finishes using the archive.
        Specified by:
        finish in interface IDocArchiveWriter
        Throws:
        java.io.IOException
      • close

        public void close()
                   throws java.io.IOException
        Throws:
        java.io.IOException
      • toFileArchive

        public void toFileArchive​(java.lang.String fileArchiveName)
                           throws java.io.IOException
        Convert the current folder archive to file archive. The original folder archive will NOT be removed.
        Parameters:
        fileArchiveName -
        Throws:
        java.io.IOException
      • flush

        public void flush()
                   throws java.io.IOException
        Description copied from interface: IDocArchiveWriter
        This function flushs all the buffers in the writer
        Specified by:
        flush in interface IDocArchiveWriter
        Throws:
        java.io.IOException
      • lock

        public java.lang.Object lock​(java.lang.String stream)
                              throws java.io.IOException
        Description copied from interface: IDocArchiveWriter
        try to lock the stream
        Specified by:
        lock in interface IDocArchiveWriter
        Returns:
        the locker.
        Throws:
        java.io.IOException
      • unlock

        public void unlock​(java.lang.Object lock)
        Description copied from interface: IDocArchiveWriter
        unlock the stream locked by the object.
        Specified by:
        unlock in interface IDocArchiveWriter
        Parameters:
        lock - object returned by the lock().
      • listStreams

        public java.util.List<java.lang.String> listStreams​(java.lang.String relativeStoragePath)
                                                     throws java.io.IOException
        return a list of strings which are the relative path of streams
        Specified by:
        listStreams in interface IDocArchiveWriter
        Parameters:
        relativeStoragePath - - the relative stream path in the archive. The relative path is based on Unix syntax, with the root of the archive denoted by "/". The initial "/" character can be skipped.
        Returns:
        a list of strings representing the underlying stream names. The return values are in the relative path format too.
        Throws:
        java.io.IOException
      • listAllStreams

        public java.util.List<java.lang.String> listAllStreams()
                                                        throws java.io.IOException
        Description copied from interface: IDocArchiveWriter
        get all the stream in the archive file.
        Specified by:
        listAllStreams in interface IDocArchiveWriter
        Returns:
        Throws:
        java.io.IOException