Package org.apache.lucene.util.fst

Class OnHeapFSTStore

java.lang.Object

org.apache.lucene.util.fst.OnHeapFSTStore

All Implemented Interfaces:

Accountable, FSTStore

public final class OnHeapFSTStore
extends java.lang.Object
implements FSTStore

Provides storage of finite state machine (FST), using byte array or byte store allocated on heap.

Field Summary

Fields

Modifier and Type	Field	Description
private static long	BASE_RAM_BYTES_USED
private BytesStore	bytes	A BytesStore, used during building, or during reading when the FST is very large (more than 1 GB).
private byte[]	bytesArray	Used at read time when the FST fits into a single byte[].
private int	maxBlockBits

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
OnHeapFSTStore(int maxBlockBits)

Method Summary

Modifier and Type	Method	Description
FST.BytesReader	getReverseBytesReader()
void	init(DataInput in, long numBytes)
long	ramBytesUsed()	Return the memory usage of this object in bytes.
long	size()
void	writeTo(DataOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.util.Accountable

getChildResources

Field Detail

BASE_RAM_BYTES_USED

private static final long BASE_RAM_BYTES_USED

bytes

private BytesStore bytes

A BytesStore, used during building, or during reading when the FST is very large (more than 1 GB). If the FST is less than 1 GB then bytesArray is set instead.

bytesArray

private byte[] bytesArray

Used at read time when the FST fits into a single byte[].

maxBlockBits

private final int maxBlockBits

Constructor Detail

OnHeapFSTStore

public OnHeapFSTStore(int maxBlockBits)

Method Detail

init

public void init(DataInput in,
                 long numBytes)
          throws java.io.IOException

Specified by:

init in interface FSTStore

Throws:

java.io.IOException

size

public long size()

Specified by:

size in interface FSTStore

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

Return the memory usage of this object in bytes. Negative values are illegal.

Specified by:

ramBytesUsed in interface Accountable

getReverseBytesReader

public FST.BytesReader getReverseBytesReader()

Specified by:

getReverseBytesReader in interface FSTStore

writeTo

public void writeTo(DataOutput out)
             throws java.io.IOException

Specified by:

writeTo in interface FSTStore

Throws:

java.io.IOException