org.nustaq.offheap

Class FSTCodedOffheapMap<K,V>

java.lang.Object

org.nustaq.offheap.FSTBinaryOffheapMap

org.nustaq.offheap.FSTCodedOffheapMap<K,V>

Direct Known Subclasses:

FSTSerializedOffheapMap

public abstract class FSTCodedOffheapMap<K,V>
extends FSTBinaryOffheapMap

An offheap map adding mechanics to encode and decode keys and values. Again remember keys have to be of fixed size and should be as short as possible. Performance and memory consumtpion is best if significant digits are at the end of a key (e.g. "year_montH_day" instead "day_month_year". This class can be used for manual implementation of encoding/decoding. See StringOffHeapMap for an example on how to do efficient wrapping/encoding of keys

Nested Class Summary

Nested classes/interfaces inherited from class org.nustaq.offheap.FSTBinaryOffheapMap

FSTBinaryOffheapMap.KeyValIter

Field Summary

Fields inherited from class org.nustaq.offheap.FSTBinaryOffheapMap

alloc, bytezOffset, CORE_HEADER_LEN, CUSTOM_FILEHEADER_LEN, customHeader, FILE_HEADER_LEN, freeList, GB, index, KEY_OFFSET_IN_HEADER, keyLen, mappedFile, MB, memory, numElem

Constructor Summary

Constructors

Constructor and Description
FSTCodedOffheapMap(int keyLen, long sizeMemBytes, int numberOfElems)
FSTCodedOffheapMap(String mappedFile, int keyLen, long sizeMemBytes, int numberOfElems)

Method Summary

Modifier and Type	Method and Description
abstract V	decodeValue(BytezByteSource val)
abstract ByteSource	encodeKey(K key)
abstract ByteSource	encodeValue(V value)
V	get(K key)
void	put(K key, V value)
void	remove(K key)
Iterator<V>	values() Warning: Concurrent Modification (e.g.

Methods inherited from class org.nustaq.offheap.FSTBinaryOffheapMap

addEntry, addToFreeList, binaryKeys, binaryValues, decElems, dumpIndexStats, finalize, free, getBinary, getCapacityMB, getContentLenFromHeader, getCustomFileHeader, getEntryLengthForContentLength, getFreeMem, getHeaderLen, getLenFromHeader, getSize, getUsedMem, incElems, init, initFromFile, printBinaryKey, putBinary, removeBinary, removeEntry, setEntry, writeEntryHeader

Methods inherited from class java.lang.Object

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

Constructor Detail

FSTCodedOffheapMap

public FSTCodedOffheapMap(int keyLen,
                          long sizeMemBytes,
                          int numberOfElems)

FSTCodedOffheapMap

public FSTCodedOffheapMap(String mappedFile,
                          int keyLen,
                          long sizeMemBytes,
                          int numberOfElems)
                   throws Exception

Throws:

Exception

Method Detail

encodeKey

public abstract ByteSource encodeKey(K key)

encodeValue

public abstract ByteSource encodeValue(V value)

decodeValue

public abstract V decodeValue(BytezByteSource val)

get

public V get(K key)

put

public void put(K key,
                V value)

remove

public void remove(K key)

values

public Iterator<V> values()

Warning: Concurrent Modification (e.g. add remove elements during iteration) is NOT SUPPORTED and NOT CHECKED. Collect keys to change inside an iteration and perform changes on the map after iteration is finished.

Returns:

an iterator on the values contained in this map.