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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JDB2Reader.RecordDescription	Description of a JDB2 record located in a database file.

Constructor Summary

Constructors

Constructor	Description
JDB2Reader(File f)	Open a JDB2 reader on a database file.

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)	Retrieve the description of a record of a given type.
List<JDB2Reader.RecordDescription>	getRecordDescriptions()	Retrieve the descriptions of all records contained in the database.
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

Open a JDB2 reader on a database file.

Parameters:

f - JDB2 file

Throws:

IOException - if the file cannot be opened or does not start with a valid JDB2 header

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:

the originating JEB version encoded as an integer

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:

true if a backing file is available

getBackingFile

public File getBackingFile()

Description copied from interface: IFileDatabaseReader

Retrieve the backing file, if any.

Specified by:

getBackingFile in interface IFileDatabaseReader

Returns:

the backing file

getRecordDescriptions

public List<JDB2Reader.RecordDescription> getRecordDescriptions()

Description copied from interface: IFileDatabaseReader

Retrieve the descriptions of all records contained in the database.

Specified by:

getRecordDescriptions in interface IFileDatabaseReader

Returns:

the record descriptions in storage order

getRecordDescription

public JDB2Reader.RecordDescription getRecordDescription(int type)

Description copied from interface: IFileDatabaseReader

Retrieve the description of a record of a given type.

Specified by:

getRecordDescription in interface IFileDatabaseReader

Parameters:

type - record type

Returns:

the matching record description, or null if no such record exists

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 - if the record could not be retrieved

getRecord

public InputStream getRecord(JDB2Reader.RecordDescription r)
                      throws IOException

Description copied from interface: IFileDatabaseReader

Retrieve a record.

Specified by:

getRecord in interface IFileDatabaseReader

Parameters:

r - record description

Returns:

record data stream

Throws:

IOException - if the record could not be retrieved

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException