public class FolderArchiveReader extends java.lang.Object implements IDocArchiveReader
Constructor and Description |
---|
FolderArchiveReader(java.lang.String folderName) |
FolderArchiveReader(java.lang.String folderName,
boolean contentEscape) |
Modifier and Type | Method and Description |
---|---|
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()
return the folder name as the report archive name
|
RAInputStream |
getStream(java.lang.String relativePath)
returns a sequential access file.
|
java.util.List<java.lang.String> |
listAllStreams()
get all the stream in the archive file.
|
java.util.List<java.lang.String> |
listStreams(java.lang.String relativeStoragePath)
return a list of strings which are the relative path of streams
|
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 lock)
unlock the stream locked by the object.
|
public FolderArchiveReader(java.lang.String folderName, boolean contentEscape) throws java.io.IOException
folderName
- contentEscape
- old document should be false.java.io.IOException
public FolderArchiveReader(java.lang.String folderName) throws java.io.IOException
folderName
- -
the absolute name of the folder archivejava.io.IOException
public java.lang.String getName()
getName
in interface IDocArchiveReader
public void open()
IDocArchiveReader
open
in interface IDocArchiveReader
public void close() throws java.io.IOException
IDocArchiveReader
close
in interface IDocArchiveReader
java.io.IOException
public RAInputStream getStream(java.lang.String relativePath) throws java.io.IOException
IDocArchiveReader
getStream
in interface IDocArchiveReader
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
public RAInputStream getInputStream(java.lang.String relativePath) throws java.io.IOException
getInputStream
in interface IDocArchiveReader
java.io.IOException
public boolean exists(java.lang.String relativePath)
exists
in interface IDocArchiveReader
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.public java.util.List<java.lang.String> listStreams(java.lang.String relativeStoragePath) throws java.io.IOException
listStreams
in interface IDocArchiveReader
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
public java.util.List<java.lang.String> listAllStreams() throws java.io.IOException
IDocArchiveReader
listAllStreams
in interface IDocArchiveReader
java.io.IOException
public java.lang.Object lock(java.lang.String stream) throws java.io.IOException
IDocArchiveReader
lock
in interface IDocArchiveReader
java.io.IOException
public void unlock(java.lang.Object lock)
IDocArchiveReader
unlock
in interface IDocArchiveReader
lock
- object returned by the lock().Copyright © 2008 Actuate Corp. All rights reserved.