Module org.apache.lucene.misc

Package org.apache.lucene.misc.store

Class ByteWritesTrackingDirectoryWrapper

java.lang.Object

org.apache.lucene.store.Directory

org.apache.lucene.store.FilterDirectory

org.apache.lucene.misc.store.ByteWritesTrackingDirectoryWrapper

All Implemented Interfaces:

Closeable, AutoCloseable

public final class ByteWritesTrackingDirectoryWrapper
extends FilterDirectory

FilterDirectory that tracks write amplification factor

Field Summary

Fields

Modifier and Type	Field	Description
private final AtomicLong	flushedBytes
private final AtomicLong	mergedBytes
final boolean	trackTempOutput

Fields inherited from class org.apache.lucene.store.FilterDirectory

in

Constructor Summary

Constructors

Constructor	Description
ByteWritesTrackingDirectoryWrapper(Directory in)
ByteWritesTrackingDirectoryWrapper(Directory in, boolean trackTempOutput)	Constructor with option to track tempOutput

Method Summary

Modifier and Type	Method	Description
private IndexOutput	createByteTrackingOutput(IndexOutput output, IOContext.Context context)
IndexOutput	createOutput(String name, IOContext ioContext)	Creates a new, empty file in the directory and returns an IndexOutput instance for appending data to this file.
IndexOutput	createTempOutput(String prefix, String suffix, IOContext ioContext)	Creates a new, empty, temporary file in the directory and returns an IndexOutput instance for appending data to this file.
long	getFlushedBytes()
long	getMergedBytes()

Methods inherited from class org.apache.lucene.store.FilterDirectory

close, deleteFile, ensureOpen, fileLength, getDelegate, getPendingDeletions, listAll, obtainLock, openInput, rename, sync, syncMetaData, toString, unwrap

Methods inherited from class org.apache.lucene.store.Directory

copyFrom, getTempFileName, openChecksumInput

Methods inherited from class java.lang.Object

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

Field Details

flushedBytes

private final AtomicLong flushedBytes

mergedBytes

private final AtomicLong mergedBytes

trackTempOutput

public final boolean trackTempOutput

Constructor Details

ByteWritesTrackingDirectoryWrapper

public ByteWritesTrackingDirectoryWrapper(Directory in)

ByteWritesTrackingDirectoryWrapper

public ByteWritesTrackingDirectoryWrapper(Directory in,
 boolean trackTempOutput)

Constructor with option to track tempOutput

Parameters:

in - input Directory

trackTempOutput - if true, will also track temporary outputs created by this directory

Method Details

createOutput

public IndexOutput createOutput(String name,
 IOContext ioContext)
                         throws IOException

Description copied from class: Directory

Creates a new, empty file in the directory and returns an IndexOutput instance for appending data to this file.

This method must throw FileAlreadyExistsException if the file already exists.

Overrides:

createOutput in class FilterDirectory

Parameters:

name - the name of the file to create.

Throws:

IOException - in case of I/O error

createTempOutput

public IndexOutput createTempOutput(String prefix,
 String suffix,
 IOContext ioContext)
                             throws IOException

Description copied from class: Directory

Creates a new, empty, temporary file in the directory and returns an IndexOutput instance for appending data to this file.

The temporary file name (accessible via IndexOutput.getName()) will start with prefix, end with suffix and have a reserved file extension .tmp.

Overrides:

createTempOutput in class FilterDirectory

Throws:

IOException

createByteTrackingOutput

private IndexOutput createByteTrackingOutput(IndexOutput output,
 IOContext.Context context)

getFlushedBytes

public long getFlushedBytes()

getMergedBytes

public long getMergedBytes()