com.milaboratory.core.io.util

Class FileIndexBuilder

java.lang.Object

com.milaboratory.core.io.util.FileIndexBuilder

public final class FileIndexBuilder
extends Object

FileIndex builder.

Constructor Summary

Constructors

Constructor and Description
FileIndexBuilder(long step) Creates index builder with specified step between records, i.e.

Method Summary

Methods

Modifier and Type	Method and Description
FileIndexBuilder	appendNextRecord(long recordSize) Appends next record to this index builder and returns this.
FileIndex	createAndDestroy() Creates FileIndex assembled by this builder.
long	lastAccessibleRecordNumber() Returns the number of the last record that is indexed by this index builder.
FileIndexBuilder	putMetadata(String key, String value) Puts metadata.
FileIndexBuilder	setStartingRecordNumber(long recordNumber) Sets the starting record number to a specified one.
FileIndexBuilder	setStartingRecordPosition(long recordPosition) Sets the starting record to a specified pointer (in bytes).

Methods inherited from class java.lang.Object

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

Constructor Detail

FileIndexBuilder

public FileIndexBuilder(long step)

Creates index builder with specified step between records, i.e. if some record with number n is indexed, then the next indexed record number will be n + step.

Parameters:

step - step between records

Method Detail

setStartingRecordPosition

public FileIndexBuilder setStartingRecordPosition(long recordPosition)

Sets the starting record to a specified pointer (in bytes).

Parameters:

recordPosition - starting record position in file (in bytes)

Returns:

this

setStartingRecordNumber

public FileIndexBuilder setStartingRecordNumber(long recordNumber)

Sets the starting record number to a specified one.

Parameters:

recordNumber - starting record number

Returns:

this

putMetadata

public FileIndexBuilder putMetadata(String key,
                           String value)

Puts metadata.

Parameters:

key - metadata key

value - metadata value

Returns:

this

appendNextRecord

public FileIndexBuilder appendNextRecord(long recordSize)

Appends next record to this index builder and returns this.

Parameters:

recordSize - size of record measured in bytes

Returns:

this

lastAccessibleRecordNumber

public long lastAccessibleRecordNumber()

Returns the number of the last record that is indexed by this index builder.

Returns:

the number of the last record that is indexed by this index builder

createAndDestroy

public FileIndex createAndDestroy()

Creates FileIndex assembled by this builder.

Returns:

FileIndex assembled by this builder