Package org.eclipse.birt.core.archive
Class FolderArchiveReader
- java.lang.Object
-
- org.eclipse.birt.core.archive.FolderArchiveReader
-
- All Implemented Interfaces:
IDocArchiveReader
public class FolderArchiveReader extends java.lang.Object implements IDocArchiveReader
-
-
Constructor Summary
Constructors Constructor Description FolderArchiveReader(java.lang.String folderName)FolderArchiveReader(java.lang.String folderName, boolean contentEscape)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()This function must be called after the reader is used.booleanexists(java.lang.String relativePath)RAInputStreamgetInputStream(java.lang.String relativePath)java.lang.StringgetName()return the folder name as the report archive nameRAInputStreamgetStream(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 streamsjava.lang.Objectlock(java.lang.String stream)try to lock the streamvoidopen()This functiona must be called before the reader is used.voidunlock(java.lang.Object lock)unlock the stream locked by the object.
-
-
-
Constructor Detail
-
FolderArchiveReader
public FolderArchiveReader(java.lang.String folderName, boolean contentEscape) throws java.io.IOException- Parameters:
folderName-contentEscape- old document should be false.- Throws:
java.io.IOException
-
FolderArchiveReader
public FolderArchiveReader(java.lang.String folderName) throws java.io.IOException- Parameters:
folderName- - the absolute name of the folder archive- Throws:
java.io.IOException
-
-
Method Detail
-
getName
public java.lang.String getName()
return the folder name as the report archive name- Specified by:
getNamein interfaceIDocArchiveReader- Returns:
- the archive name
-
open
public void 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
-
close
public void close() throws java.io.IOExceptionDescription copied from interface:IDocArchiveReaderThis function must be called after the reader is used. close the archive.- Specified by:
closein interfaceIDocArchiveReader- Throws:
java.io.IOException
-
getStream
public RAInputStream getStream(java.lang.String relativePath) throws java.io.IOException
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:
java.io.IOException
-
getInputStream
public RAInputStream getInputStream(java.lang.String relativePath) throws java.io.IOException
- Specified by:
getInputStreamin interfaceIDocArchiveReader- Throws:
java.io.IOException
-
exists
public boolean exists(java.lang.String relativePath)
- 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
-
listStreams
public java.util.List<java.lang.String> listStreams(java.lang.String relativeStoragePath) throws java.io.IOExceptionreturn a list of strings which are the relative path of streams- Specified by:
listStreamsin interfaceIDocArchiveReader- Parameters:
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.- Returns:
- a list of strings representing the underlying stream names. The return values are in the relative path format too.
- Throws:
java.io.IOException
-
listAllStreams
public java.util.List<java.lang.String> listAllStreams() throws java.io.IOExceptionDescription copied from interface:IDocArchiveReaderget all the stream in the archive file.- Specified by:
listAllStreamsin interfaceIDocArchiveReader- Returns:
- Throws:
java.io.IOException
-
lock
public java.lang.Object lock(java.lang.String stream) throws java.io.IOExceptionDescription copied from interface:IDocArchiveReadertry to lock the stream- Specified by:
lockin interfaceIDocArchiveReader- Returns:
- the locker.
- Throws:
java.io.IOException
-
unlock
public void unlock(java.lang.Object lock)
Description copied from interface:IDocArchiveReaderunlock the stream locked by the object.- Specified by:
unlockin interfaceIDocArchiveReader- Parameters:
lock- object returned by the lock().
-
-