com.milaboratory.core.io.util

Class FileIndex

java.lang.Object

com.milaboratory.core.io.util.FileIndex

public final class FileIndex
extends Object

Index of file that contains sequential records.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAGIC For serialization

Method Summary

Methods

Modifier and Type	Method and Description
long	getLastRecordNumber() Returns the last record number indexed by this index.
String	getMetadata(String key) Returns a metadata record.
long	getNearestPosition(long recordNumber) Returns the nearest (from the left side, i.e.
long	getNearestRecordNumber(long recordNumber) Returns the record number, which is nearest (from the left side, i.e.
long	getStartingRecordNumber() Returns the first record number indexed by this index.
long	getStep() Returns step of current index
static FileIndex	read(File file) Reads index from file.
static FileIndex	read(InputStream stream) Reads index from input stream.
static FileIndex	read(String fileName) Reads index from file.
void	write(File file) Writes this index to specified file.
void	write(OutputStream stream) Writes this index to specified output stream.
void	write(String fileName) Writes this index to specified file.

Methods inherited from class java.lang.Object

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

Field Detail

MAGIC

public static final int MAGIC

For serialization

See Also:

Constant Field Values

Method Detail

getStep

public long getStep()

Returns step of current index

Returns:

step of current index

getStartingRecordNumber

public long getStartingRecordNumber()

Returns the first record number indexed by this index.

Returns:

the first record number indexed by this index

getLastRecordNumber

public long getLastRecordNumber()

Returns the last record number indexed by this index.

Returns:

the last record number indexed by this index

getMetadata

public String getMetadata(String key)

Returns a metadata record.

Parameters:

key - metadata key

Returns:

metadata record

getNearestPosition

public long getNearestPosition(long recordNumber)

Returns the nearest (from the left side, i.e. smaller) position (in bytes) to specified record number.

Parameters:

recordNumber - number of record

Returns:

nearest (from the left side, i.e. smaller) position (in bytes) to specified record number

getNearestRecordNumber

public long getNearestRecordNumber(long recordNumber)

Returns the record number, which is nearest (from the left side, i.e. smaller) to the specified record number.

Parameters:

recordNumber - number of record

Returns:

record number, which is nearest (from the left side, i.e. smaller) to the specified record number

write

public void write(String fileName)
           throws IOException

Writes this index to specified file.

Parameters:

fileName - file name

Throws:

IOException

write

public void write(File file)
           throws IOException

Writes this index to specified file.

Parameters:

file - file

Throws:

IOException

write

public void write(OutputStream stream)
           throws IOException

Writes this index to specified output stream.

Parameters:

stream - output stream

Throws:

IOException

read

public static FileIndex read(String fileName)
                      throws IOException

Reads index from file.

Parameters:

fileName - input file name

Returns:

FileIndex

Throws:

IOException

read

public static FileIndex read(File file)
                      throws IOException

Reads index from file.

Parameters:

file - input file

Returns:

FileIndex

Throws:

IOException

read

public static FileIndex read(InputStream stream)
                      throws IOException

Reads index from input stream.

Parameters:

stream - input stream

Returns:

FileIndex

Throws:

IOException