Class ArchiveReader
java.lang.Object
org.eclipse.birt.core.archive.compound.ArchiveReader
- All Implemented Interfaces:
IDocArchiveReader
- Direct Known Subclasses:
FileArchiveReader
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()This function must be called after the reader is used.booleangetInputStream(String relativePath) getName()returns a sequential access file.get all the stream in the archive file.listStreams(String namePattern) try to lock the streamvoidopen()This functiona must be called before the reader is used.voidunlock the stream locked by the object.
-
Field Details
-
archive
-
-
Constructor Details
-
ArchiveReader
- Throws:
IOException
-
ArchiveReader
- Throws:
IOException
-
-
Method Details
-
close
Description copied from interface:IDocArchiveReaderThis function must be called after the reader is used. close the archive.- Specified by:
closein interfaceIDocArchiveReader- Throws:
IOException
-
getArchive
-
exists
- Specified by:
existsin interfaceIDocArchiveReader- 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. Used mainly for sequential streams in report.- Returns:
- whether the stream exist
-
getName
- Specified by:
getNamein interfaceIDocArchiveReader- Returns:
- the archive name
-
getStream
Description copied from interface:IDocArchiveReaderreturns a sequential access file.- Specified by:
getStreamin interfaceIDocArchiveReader- 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. Used mainly for sequential streams in report.- Returns:
- RAInputStream
- Throws:
IOException
-
getInputStream
- Specified by:
getInputStreamin interfaceIDocArchiveReader- Throws:
IOException
-
listAllStreams
Description copied from interface:IDocArchiveReaderget all the stream in the archive file.- Specified by:
listAllStreamsin interfaceIDocArchiveReader- Returns:
- Throws:
IOException
-
listStreams
- Specified by:
listStreamsin interfaceIDocArchiveReader- Parameters:
namePattern- - 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:
IOException
-
open
Description copied from interface:IDocArchiveReaderThis functiona must be called before the reader is used. initialize the document archive. For example, the index stream mey be read into memory.- Specified by:
openin interfaceIDocArchiveReader- Throws:
IOException
-
lock
Description copied from interface:IDocArchiveReadertry to lock the stream- Specified by:
lockin interfaceIDocArchiveReader- Returns:
- the locker.
- Throws:
IOException
-
unlock
Description copied from interface:IDocArchiveReaderunlock the stream locked by the object.- Specified by:
unlockin interfaceIDocArchiveReader- Parameters:
locker- object returned by the lock().
-