tech.sourced.siva

Class SivaReader

java.lang.Object

tech.sourced.siva.SivaReader

public class SivaReader
extends java.lang.Object

SivaReader and all its outputs are thread safe. This class handles the unpacked process of a siva file.

Constructor Summary

Constructors

Constructor and Description
SivaReader(java.io.File sivaFile) Create a SivaReader from a siva file.

Method Summary

Modifier and Type	Method and Description
void	close() Close closes the siva reader.
java.io.InputStream	getEntry(IndexEntry indexEntry) getEntry returns the file referenced by the provided IndexEntry.
IndexReader	getIndex() getIndex provides an IndexReader that points to the index into the siva file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SivaReader

public SivaReader(java.io.File sivaFile)
           throws java.io.FileNotFoundException

Create a SivaReader from a siva file.

Parameters:

sivaFile - The siva file.

Throws:

java.io.FileNotFoundException - If the file does not exists.

Method Detail

getEntry

public final java.io.InputStream getEntry(IndexEntry indexEntry)
                                   throws SivaException

getEntry returns the file referenced by the provided IndexEntry. Entries can be obtained from getIndex() method.

Parameters:

indexEntry - entry obtained from the siva index

Returns:

InputStream to be able to read the entire expected file.

Throws:

SivaException - If some problem happens trying to read the siva file.

getIndex

public final IndexReader getIndex()

getIndex provides an IndexReader that points to the index into the siva file. Is recommended to get an index per thread, but anyways IndexReader is thread safe.

Returns:

an IndexReader

close

public final void close()
                 throws SivaException

Close closes the siva reader. When it is closed, it cannot be reused.

Throws:

SivaException - if some error happens when we tried to close the internal channel or the siva file reader.