Package gov.nih.mipav.model.file

Class DelimitedRandomAccessFile

java.lang.Object

java.io.RandomAccessFile

gov.nih.mipav.model.file.DelimitedRandomAccessFile

All Implemented Interfaces:

Closeable, DataInput, DataOutput, AutoCloseable

public class DelimitedRandomAccessFile
extends RandomAccessFile

This class is a random access file that has an internal delimiter for fast processing of text files. It can be used to read in legacy text files, such as comma-separated VOIs.

Author:

Justin Senseney

Field Summary

Fields

Modifier and Type	Field	Description
private char	delim	The delimiter that separates each str chunk.

Constructor Summary

Constructors

Constructor	Description
DelimitedRandomAccessFile(File file, String mode, char delim)	This constructor first performs the same actions as RandomAccessFile(File file, String mode), it then sets the file's delimiter to delim.
DelimitedRandomAccessFile(String name, String mode, char delim)	This constructor first performs the same actions as RandomAccessFile(String name, String mode), it then sets the file's delimiter to delim.

Method Summary

Modifier and Type	Method	Description
char	getDelimiter()
static void	main(String[] args)
String	readDelimitedBytes()	Reads a string from the file up to the current delimiter.
String	readDelimitedBytes(char tempDelim)	This method retrieves a String consisting of all characters from the current pointer location in the random access file and the temporary delimiter.
void	setDelimiter(char delim)
void	writeDelimitedBytes(String str)	Writes a string terminated by the current delimiter.
void	writeDelimitedBytes(String str, char tempDelim)	Allows for writing with a temporary delimiter.

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

Field Details

delim

private char delim

The delimiter that separates each str chunk.

Constructor Details

DelimitedRandomAccessFile

public DelimitedRandomAccessFile(String name,
 String mode,
 char delim)
                          throws FileNotFoundException

This constructor first performs the same actions as RandomAccessFile(String name, String mode), it then sets the file's delimiter to delim.

Throws:

FileNotFoundException

See Also:

• invalid reference

  RandomAccessFile(String name, String mode)

DelimitedRandomAccessFile

public DelimitedRandomAccessFile(File file,
 String mode,
 char delim)
                          throws FileNotFoundException

This constructor first performs the same actions as RandomAccessFile(File file, String mode), it then sets the file's delimiter to delim.

Throws:

FileNotFoundException

See Also:

• invalid reference

  RandomAccessFile(File file, String mode)

Method Details

writeDelimitedBytes

public void writeDelimitedBytes(String str)
                         throws IOException

Writes a string terminated by the current delimiter.

Parameters:

str - the string to be written

Throws:

IOException

writeDelimitedBytes

public void writeDelimitedBytes(String str,
 char tempDelim)
                         throws IOException

Allows for writing with a temporary delimiter.

Parameters:

tempDelim - delimiter to be used for this method call only

Throws:

IOException

See Also:

• writeDelimitedBytes(java.lang.String)

readDelimitedBytes

public String readDelimitedBytes()
                          throws IOException

Reads a string from the file up to the current delimiter. Note that an EOF exception is caught, with the final string of the file returned

Returns:

the read string

Throws:

IOException

See Also:

• EOFException

readDelimitedBytes

public String readDelimitedBytes(char tempDelim)
                          throws IOException

This method retrieves a String consisting of all characters from the current pointer location in the random access file and the temporary delimiter.

Parameters:

tempDelim - the temporary delimiter for this class

Returns:

the string up to tempDelim (exclusive)

Throws:

IOException

getDelimiter

public char getDelimiter()

setDelimiter

public void setDelimiter(char delim)

main

public static void main(String[] args)
                 throws IOException

Throws:

IOException