public class ArchiveReader extends java.lang.Object implements IDocArchiveReader
Modifier and Type | Field and Description |
---|---|
protected IArchiveFile |
archive |
protected boolean |
shareArchive |
Constructor and Description |
---|
ArchiveReader(IArchiveFile archive) |
ArchiveReader(java.lang.String archiveName) |
Modifier and Type | Method and Description |
---|---|
void |
close()
This function must be called after the reader is used.
|
boolean |
exists(java.lang.String relativePath) |
IArchiveFile |
getArchive() |
RAInputStream |
getInputStream(java.lang.String relativePath) |
java.lang.String |
getName() |
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 namePattern) |
java.lang.Object |
lock(java.lang.String relativePath)
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.
|
protected IArchiveFile archive
protected boolean shareArchive
public ArchiveReader(IArchiveFile archive) throws java.io.IOException
java.io.IOException
public ArchiveReader(java.lang.String archiveName) throws java.io.IOException
java.io.IOException
public void close() throws java.io.IOException
IDocArchiveReader
close
in interface IDocArchiveReader
java.io.IOException
public IArchiveFile getArchive()
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.lang.String getName()
getName
in interface IDocArchiveReader
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 java.util.List<java.lang.String> listAllStreams() throws java.io.IOException
IDocArchiveReader
listAllStreams
in interface IDocArchiveReader
java.io.IOException
public java.util.List<java.lang.String> listStreams(java.lang.String namePattern) throws java.io.IOException
listStreams
in interface IDocArchiveReader
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.java.io.IOException
public void open() throws java.io.IOException
IDocArchiveReader
open
in interface IDocArchiveReader
java.io.IOException
public java.lang.Object lock(java.lang.String relativePath) throws java.io.IOException
IDocArchiveReader
lock
in interface IDocArchiveReader
java.io.IOException
public void unlock(java.lang.Object locker)
IDocArchiveReader
unlock
in interface IDocArchiveReader
locker
- object returned by the lock().Copyright © 2008 Actuate Corp. All rights reserved.