|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDocArchiveReader
An interface that wraps around a report archive for reading. A report archive may be, but is not limited to a zip file in compressed format, a folder in uncompressed format. Notice that the interface does not define archive file name, nor does it define folder name to store/uncompress the archive to. Setting such environments up is implementation class's responsibility. To external users of IReportArchive, it only cares what he can retrieve from the archive.
Method Summary | |
---|---|
void |
close()
This function must be called after the reader is used. |
boolean |
exists(java.lang.String relativePath)
|
RAInputStream |
getInputStream(java.lang.String relativePath)
|
java.lang.String |
getName()
|
RAInputStream |
getStream(java.lang.String relativePath)
returns a sequential access file. |
java.util.List |
listAllStreams()
get all the stream in the archive file. |
java.util.List |
listStreams(java.lang.String relativeStoragePath)
|
java.lang.Object |
lock(java.lang.String stream)
try to lock the stream |
void |
open()
This functiona must be called before the reader is used. |
void |
unlock(java.lang.Object locker)
unlock the stream locked by the object. |
Method Detail |
---|
java.lang.String getName()
void open() throws java.io.IOException
java.io.IOException
RAInputStream getStream(java.lang.String relativePath) throws java.io.IOException
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.
java.io.IOException
RAInputStream getInputStream(java.lang.String relativePath) throws java.io.IOException
java.io.IOException
boolean exists(java.lang.String relativePath)
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.
java.util.List listStreams(java.lang.String relativeStoragePath) throws java.io.IOException
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.
java.io.IOException
java.util.List listAllStreams() throws java.io.IOException
java.io.IOException
void close() throws java.io.IOException
java.io.IOException
java.lang.Object lock(java.lang.String stream) throws java.io.IOException
stream
-
java.io.IOException
void unlock(java.lang.Object locker)
locker
- object returned by the lock().
java.io.IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |