Package com.pnfsoftware.jeb.core.dao.impl

Class JDB2Reader

java.lang.Object

com.pnfsoftware.jeb.core.dao.impl.JDB2Reader

All Implemented Interfaces:

IFileDatabaseReader, Closeable, AutoCloseable

public class JDB2Reader
extends Object
implements IFileDatabaseReader

JDB2 (JEB saved project database) record reader. A JDB2 is made of records.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JDB2Reader.RecordDescription	Definition of a JDB2 record.

Constructor Summary

Constructors

Constructor	Description
JDB2Reader(File f)

Method Summary

Modifier and Type	Method	Description
void	close()
File	getBackingFile()	Retrieve the backing file, if any.
int	getJebVersionInt()	Retrieve the version-integer of the JEB build that originally created the JDB2 database.
InputStream	getRecord(int type)	Retrieve a record.
InputStream	getRecord(JDB2Reader.RecordDescription r)	Retrieve a record.
JDB2Reader.RecordDescription	getRecordDescription(int type)
List<JDB2Reader.RecordDescription>	getRecordDescriptions()
boolean	hasBackingFile()	Determine if this database is backed by a file.

Methods inherited from class java.lang.Object

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

Constructor Details

JDB2Reader

public JDB2Reader(File f)
           throws IOException

Throws:

IOException

Method Details

getJebVersionInt

public int getJebVersionInt()

Retrieve the version-integer of the JEB build that originally created the JDB2 database. On older JDB2, this value is not set and will be 0. If a non-zero value is returned, it can be converted to a partial version object using Version.fromInt(int).

Returns:

hasBackingFile

public boolean hasBackingFile()

Description copied from interface: IFileDatabaseReader

Determine if this database is backed by a file.

Specified by:

hasBackingFile in interface IFileDatabaseReader

Returns:

getBackingFile

public File getBackingFile()

Description copied from interface: IFileDatabaseReader

Retrieve the backing file, if any.

Specified by:

getBackingFile in interface IFileDatabaseReader

Returns:

getRecordDescriptions

public List<JDB2Reader.RecordDescription> getRecordDescriptions()

Specified by:

getRecordDescriptions in interface IFileDatabaseReader

Returns:

getRecordDescription

public JDB2Reader.RecordDescription getRecordDescription(int type)

Specified by:

getRecordDescription in interface IFileDatabaseReader

Parameters:

type - record type

Returns:

getRecord

public InputStream getRecord(int type)
                      throws IOException

Description copied from interface: IFileDatabaseReader

Retrieve a record.

Specified by:

getRecord in interface IFileDatabaseReader

Parameters:

type - record type

Returns:

record data stream

Throws:

IOException

getRecord

public InputStream getRecord(JDB2Reader.RecordDescription r)
                      throws IOException

Description copied from interface: IFileDatabaseReader

Retrieve a record.

Specified by:

getRecord in interface IFileDatabaseReader

Returns:

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException