Interface IArchiveFileFactory

All Known Implementing Classes:
ArchiveFileFactory

public interface IArchiveFileFactory
  • Method Details

    • openArchive

      IArchiveFile openArchive(String archiveId, String mode) throws IOException
      Open the archive or view. The mode can be either: - "r" the archive file is opened for read only. - "rw" the archive file is opened for read and write. - "rw+" the archive file is opened for read and append. 1. in "r" mode a. view: open view in r mode, and open archive in r mode at the same time. b. archive: open archive in r mode directly. 2. in "rw" mode a. view&archive: only create new archive file 3. in "rw+" a. view: open view in rw+ mode, and open archive in r mode at the same time. b. archive: open archive in rw+ mode.
      Parameters:
      archiveId - the system id of the opening archive
      mode - opening mode
      Returns:
      opened archive
      Throws:
      IOException
    • openView

      IArchiveFile openView(String viewId, String mode, IArchiveFile archive) throws IOException
      Open the view with viewId in mode mode, the depend archive file is opened in r mode, and is shared. The mode can be either: - "r" the view file is opened for read only. - "rw" the view file is opened for read and write. - "rw+" the view file is opened for read and append. The depend archive file will not be closed when view file is closed.
      Parameters:
      viewId - the system id of the opening view
      mode - opening mode
      archive - depend archive file
      Returns:
      opened view
      Throws:
      IOException
    • createArchive

      IArchiveFile createArchive(String archiveId) throws IOException
      Create an archive file. The created archive uses archiveId as the identifier. If the file has exist already, the file is removed first. It can only be used to create an archive. To create a view, the user needs use createView.
      Parameters:
      archiveId - the system id of the new archive file
      fileName - the file name of the archive file
      Returns:
      an archive file with the archiveId
      Throws:
      IOException
    • createTransientArchive

      IArchiveFile createTransientArchive(String archiveId) throws IOException
      Create an archive in transient mode.
      Parameters:
      archiveId -
      fileName -
      Returns:
      Throws:
      IOException
    • createView

      IArchiveFile createView(String viewId, IArchiveFile archive) throws IOException
      Create a view, the view uses "viewId" as the identifier and saved into file "filename". The base archive "archive" can be either a view or an archive. If it is a view, the new generated view is based on the original archive.
      Parameters:
      viewId - the system id of the new view file
      archive - the depended archive file instance
      Returns:
      Throws:
      IOException
    • createTransientView

      IArchiveFile createTransientView(String viewId, IArchiveFile archive) throws IOException
      Create a transient view.
      Parameters:
      viewId - the system id of the new view file
      archive - the depended archive file instance
      Returns:
      Throws:
      IOException