org.apache.nifi.provenance.toc

Interface TocWriter

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

NopTocWriter, StandardTocWriter

public interface TocWriter
extends java.io.Closeable

Writes a Table-of-Contents (.toc) file

Method Summary

Modifier and Type	Method and Description
void	addBlockOffset(long offset, long firstEventId) Adds the given block offset as the next Block Offset in the Table of Contents
int	getCurrentBlockIndex()
java.io.File	getFile()
void	sync() Synchronizes the data with the underlying storage device

Methods inherited from interface java.io.Closeable

close

Method Detail

addBlockOffset

void addBlockOffset(long offset,
                    long firstEventId)
             throws java.io.IOException

Adds the given block offset as the next Block Offset in the Table of Contents

Parameters:

offset - the byte offset at which the block begins

firstEventId - the ID of the first Provenance Event that will be in the block

Throws:

java.io.IOException - if unable to persist the block index

getCurrentBlockIndex

int getCurrentBlockIndex()

Returns:

the index of the current Block

getFile

java.io.File getFile()

Returns:

the file that is currently being written to

sync

void sync()
   throws java.io.IOException

Synchronizes the data with the underlying storage device

Throws:

java.io.IOException - if unable to synchronize the data with the underlying storage device