org.shredzone.commons.pdb

Class PdbFile

java.lang.Object

java.io.RandomAccessFile

org.shredzone.commons.pdb.PdbFile

All Implemented Interfaces:

Closeable, DataInput, DataOutput, AutoCloseable

public class PdbFile
extends RandomAccessFile

Opens a PDB file and gives access to its contents.

See Also:

The Pilot Record Database Format

Constructor Summary

Constructors

Constructor and Description
PdbFile(File file) Creates a new PdbFile for the given File.

Method Summary

Modifier and Type	Method and Description
static String	convertSpecialChars(String str) Converts special PalmOS characters into their unicode equivalents.
int	readCategories(CategoryAppInfo appInfo) Reads the categories from a standard appinfo area and fills them into a CategoryAppInfo object.
<T extends Record,U extends AppInfo> PdbDatabase<T,U>	readDatabase(Converter<T,U> converter) Reads the entire database file and returns a PdbDatabase.
Calendar	readDate() Reads a PalmOS date.
Calendar	readDateTimeWords() Reads a PalmOS date and time that is stored in seven words.
String	readFixedString(int length) Reads a string of a fixed length, not null terminated.
Calendar	readPackedDate() Reads a packed PalmOS date.
String	readTerminatedFixedString(int length) Reads a string of a fixed length that is null terminated.
String	readTerminatedString() Reads a string of a variable length that is null terminated.
long	readUnsignedInt() Reads an unsigned integer.

Methods inherited from class java.io.RandomAccessFile

close, getChannel, getFD, getFilePointer, length, read, read, read, readBoolean, readByte, readChar, readDouble, readFloat, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedShort, readUTF, seek, setLength, skipBytes, write, write, write, writeBoolean, writeByte, writeBytes, writeChar, writeChars, writeDouble, writeFloat, writeInt, writeLong, writeShort, writeUTF

Methods inherited from class java.lang.Object

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

Constructor Detail

PdbFile

public PdbFile(File file)
        throws FileNotFoundException

Creates a new PdbFile for the given File.

Parameters:

file - File to be opened

Throws:

FileNotFoundException

Method Detail

readDatabase

public <T extends Record,U extends AppInfo> PdbDatabase<T,U> readDatabase(Converter<T,U> converter)
                                                                   throws IOException

Reads the entire database file and returns a PdbDatabase. You usually want to invoke this method, as the other methods are just helpers.

Type Parameters:

T - Record subclass the database shall consist of

Parameters:

converter - Converter that converts the raw database entries into Record objects

Returns:

PdbDatabase containing the file contents

Throws:

IOException - The file could not be read. This can have various reasons, for example if the file was no valid PDB file or the converter was not able to convert the file's contents.

readFixedString

public String readFixedString(int length)
                       throws IOException

Reads a string of a fixed length, not null terminated.

Parameters:

length - The length of the string

Returns:

String that was read

Throws:

IOException

readTerminatedFixedString

public String readTerminatedFixedString(int length)
                                 throws IOException

Reads a string of a fixed length that is null terminated. The given number of bytes are always read, but the everything including and after the terminator character is ignored.

Parameters:

length - The length of the string

Returns:

String that was read

Throws:

IOException

readTerminatedString

public String readTerminatedString()
                            throws IOException

Reads a string of a variable length that is null terminated.

Returns:

String that was read

Throws:

IOException

readUnsignedInt

public long readUnsignedInt()
                     throws IOException

Reads an unsigned integer.

Returns:

Unsigned integer that was read

Throws:

IOException

readDate

public Calendar readDate()
                  throws IOException

Reads a PalmOS date.

Returns:

Calendar that was read. May be null if no date was set.

Throws:

IOException

readPackedDate

public Calendar readPackedDate()
                        throws IOException

Reads a packed PalmOS date.

Returns:

Calendar containing the date read. May be null if no date was set. The time part is always midnight local time.

Throws:

IOException

readDateTimeWords

public Calendar readDateTimeWords()
                           throws IOException

Reads a PalmOS date and time that is stored in seven words.

Returns:

Calendar that was read

Throws:

IOException

readCategories

public int readCategories(CategoryAppInfo appInfo)
                   throws IOException

Reads the categories from a standard appinfo area and fills them into a CategoryAppInfo object. After invocation, the file pointer points after the category part, where further application information may be stored.

Parameters:

appInfo - CategoryAppInfo where the categories are stored.

Returns:

Bytes that were actually read from the appinfo area. The file pointer is located at the beginning of the appinfo area plus the result of this method.

Throws:

IOException

convertSpecialChars

public static String convertSpecialChars(String str)

Converts special PalmOS characters into their unicode equivalents. The string methods of PdbFile will invoke this method by itself, so you usually do not need to invoke it. Note that some very special PalmOS characters cannot be converted (as there are no unicode equivalents) and will be kept unchanged.

Parameters:

str - String to be converted

Returns:

Converted string