org.eclipse.birt.core.archive
Class FolderArchiveReader

java.lang.Object
  extended by org.eclipse.birt.core.archive.FolderArchiveReader
All Implemented Interfaces:
IDocArchiveReader

public class FolderArchiveReader
extends java.lang.Object
implements IDocArchiveReader


Constructor Summary
FolderArchiveReader(java.lang.String folderName)
           
 
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()
          return the folder name as the report archive name
 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)
          reurun 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

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:
getName in interface IDocArchiveReader
Returns:
the archive name

open

public void open()
Description copied from interface: IDocArchiveReader
This 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:
open in interface IDocArchiveReader

close

public void close()
Description copied from interface: IDocArchiveReader
This function must be called after the reader is used. close the archive.

Specified by:
close in interface IDocArchiveReader

getStream

public RAInputStream getStream(java.lang.String relativePath)
                        throws java.io.IOException
Description copied from interface: IDocArchiveReader
returns a sequential access file.

Specified by:
getStream in interface IDocArchiveReader
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:
getInputStream in interface IDocArchiveReader
Throws:
java.io.IOException

exists

public boolean exists(java.lang.String relativePath)
Specified by:
exists in interface IDocArchiveReader
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 listStreams(java.lang.String relativeStoragePath)
                           throws java.io.IOException
reurun a list of strings which are the relative path of streams

Specified by:
listStreams in interface IDocArchiveReader
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 listAllStreams()
                              throws java.io.IOException
Description copied from interface: IDocArchiveReader
get all the stream in the archive file.

Specified by:
listAllStreams in interface IDocArchiveReader
Returns:
Throws:
java.io.IOException

lock

public java.lang.Object lock(java.lang.String stream)
                      throws java.io.IOException
Description copied from interface: IDocArchiveReader
try to lock the stream

Specified by:
lock in interface IDocArchiveReader
Returns:
the locker.
Throws:
java.io.IOException

unlock

public void unlock(java.lang.Object lock)
Description copied from interface: IDocArchiveReader
unlock the stream locked by the object.

Specified by:
unlock in interface IDocArchiveReader
Parameters:
lock - object returned by the lock().


Copyright © 2008 Actuate Corp. All rights reserved.