|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDocArchiveWriter
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.
Method Summary | |
---|---|
RAOutputStream |
createOutputStream(java.lang.String relativePath)
|
RAOutputStream |
createRandomAccessStream(java.lang.String relativePath)
Create a random access stream in the archive and return it. |
boolean |
dropStream(java.lang.String relativePath)
Delete a stream from the archive. |
boolean |
exists(java.lang.String relativePath)
|
void |
finish()
This function must be called after the writer is used. |
void |
flush()
This function flushs all the buffers in the writer |
RAInputStream |
getInputStream(java.lang.String relativePath)
|
java.lang.String |
getName()
|
RAOutputStream |
getOutputStream(java.lang.String relativePath)
|
void |
initialize()
This function must be called before the writer is used. |
java.lang.Object |
lock(java.lang.String stream)
try to lock the stream |
RAOutputStream |
openRandomAccessStream(java.lang.String relativePath)
|
void |
setStreamSorter(IStreamSorter streamSorter)
Set the stream sorter (if needed). |
void |
unlock(java.lang.Object locker)
unlock the stream locked by the object. |
Method Detail |
---|
void initialize() throws java.io.IOException
java.io.IOException
java.lang.String getName()
RAOutputStream createRandomAccessStream(java.lang.String relativePath) throws java.io.IOException
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.
java.io.IOException
RAOutputStream openRandomAccessStream(java.lang.String relativePath) throws java.io.IOException
java.io.IOException
RAOutputStream createOutputStream(java.lang.String relativePath) throws java.io.IOException
java.io.IOException
RAOutputStream getOutputStream(java.lang.String relativePath) throws java.io.IOException
java.io.IOException
RAInputStream getInputStream(java.lang.String relativePath) throws java.io.IOException
java.io.IOException
boolean dropStream(java.lang.String relativePath)
relativePath
- -
the relative path of the stream
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.
void setStreamSorter(IStreamSorter streamSorter)
streamSorter
- -
the stream sortervoid finish() throws java.io.IOException
java.io.IOException
void flush() 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 |