Class ArchiveFileFactory
java.lang.Object
org.eclipse.birt.core.archive.compound.ArchiveFileFactory
- All Implemented Interfaces:
IArchiveFileFactory
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateArchive(String archiveId) Create an archive file.createTransientArchive(String archiveId) Create an archive in transient mode.createTransientView(String viewId, IArchiveFile archive) Create a transient view.createView(String viewId, IArchiveFile archive) Create a view, the view uses "viewId" as the identifier and saved into file "filename".protected StringgetPhysicalFile(String systemId) The sub class should override this method to implement its own systemId resolver.openArchive(String archiveId, String mode) Open the archive or view.openView(String viewId, String mode, IArchiveFile archive) Open the view with viewId inmodemode, the depend archive file is opened in r mode, and is shared.
-
Constructor Details
-
ArchiveFileFactory
public ArchiveFileFactory()
-
-
Method Details
-
createArchive
Description copied from interface:IArchiveFileFactoryCreate an archive file. The created archive usesarchiveIdas 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.- Specified by:
createArchivein interfaceIArchiveFileFactory- Parameters:
archiveId- the system id of the new archive file- Returns:
- an archive file with the
archiveId - Throws:
IOException
-
createTransientArchive
Description copied from interface:IArchiveFileFactoryCreate an archive in transient mode.- Specified by:
createTransientArchivein interfaceIArchiveFileFactory- Returns:
- Throws:
IOException
-
createView
Description copied from interface:IArchiveFileFactoryCreate 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.- Specified by:
createViewin interfaceIArchiveFileFactory- Parameters:
viewId- the system id of the new view filearchive- the depended archive file instance- Returns:
- Throws:
IOException
-
createTransientView
Description copied from interface:IArchiveFileFactoryCreate a transient view.- Specified by:
createTransientViewin interfaceIArchiveFileFactory- Parameters:
viewId- the system id of the new view filearchive- the depended archive file instance- Returns:
- Throws:
IOException
-
openArchive
Description copied from interface:IArchiveFileFactoryOpen 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.- Specified by:
openArchivein interfaceIArchiveFileFactory- Parameters:
archiveId- the system id of the opening archivemode- opening mode- Returns:
- opened archive
- Throws:
IOException
-
openView
Description copied from interface:IArchiveFileFactoryOpen the view with viewId inmodemode, 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.- Specified by:
openViewin interfaceIArchiveFileFactory- Parameters:
viewId- the system id of the opening viewmode- opening modearchive- depend archive file- Returns:
- opened view
- Throws:
IOException
-
getPhysicalFile
The sub class should override this method to implement its own systemId resolver.- Parameters:
systemId-- Returns:
- the physical file name
-