DB.HTreeMapMaker (mapdb 2.0-beta10 API)

java.lang.Object
- org.mapdb.DB.HTreeMapMaker

Enclosing class:: DB

public static class DB.HTreeMapMaker
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`closeEngine`
`protected boolean`	`counter`
`protected DB`	`db`
`protected Engine[]`	`engines`
`protected ScheduledExecutorService`	`executor`
`protected long`	`executorPeriod`
`protected long`	`expire`
`protected long`	`expireAccess`
`protected long`	`expireMaxSize`
`protected long`	`expireStoreSize`
`protected long`	`expireTick`
`protected Serializer<?>`	`keySerializer`
`protected String`	`name`
`protected Bind.MapWithModificationListener`	`ondisk`
`protected boolean`	`ondiskOverwrite`
`protected boolean`	`pumpIgnoreDuplicates`
`protected Fun.Function1`	`pumpKeyExtractor`
`protected int`	`pumpPresortBatchSize`
`protected Iterator`	`pumpSource`
`protected Fun.Function1`	`pumpValueExtractor`
`protected Fun.Function1<?,?>`	`valueCreator`
`protected Serializer<?>`	`valueSerializer`

Constructor Summary

Constructors
Constructor and Description

DB.HTreeMapMaker(DB db, String name, Engine[] engines)

Constructors
Constructor and Description
`DB.HTreeMapMaker(DB db, String name, Engine[] engines)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected DB.HTreeMapMaker`	`closeEngine()`
`DB.HTreeMapMaker`	`counterEnable()` by default collection does not have counter, without counter updates are faster, but entire collection needs to be traversed to count items.
`DB.HTreeMapMaker`	`executorEnable()`
`DB.HTreeMapMaker`	`executorEnable(ScheduledExecutorService executor)`
`DB.HTreeMapMaker`	`executorPeriod(long period)`
`DB.HTreeMapMaker`	`expireAfterAccess(long interval)` Specifies that each entry should be automatically removed from the map once a fixed duration has elapsed after the entry's creation, the most recent replacement of its value, or its last access.
`DB.HTreeMapMaker`	`expireAfterAccess(long interval, TimeUnit timeUnit)` Specifies that each entry should be automatically removed from the map once a fixed duration has elapsed after the entry's creation, the most recent replacement of its value, or its last access.
`DB.HTreeMapMaker`	`expireAfterWrite(long interval)` Specifies that each entry should be automatically removed from the map once a fixed duration has elapsed after the entry's creation, or the most recent replacement of its value.
`DB.HTreeMapMaker`	`expireAfterWrite(long interval, TimeUnit timeUnit)` Specifies that each entry should be automatically removed from the map once a fixed duration has elapsed after the entry's creation, or the most recent replacement of its value.
`DB.HTreeMapMaker`	`expireMaxSize(long maxSize)` maximal number of entries in this map.
`DB.HTreeMapMaker`	`expireOverflow(Bind.MapWithModificationListener ondisk, boolean overwrite)` After expiration (or deletion), put entries into given map
`DB.HTreeMapMaker`	`expireStoreSize(double maxStoreSize)` maximal size of store in GB, if store is larger entries will start expiring
`DB.HTreeMapMaker`	`expireTick(long expireTick)` Calling expiration cleanup too often reduces performance.
`DB.HTreeMapMaker`	`keySerializer(Serializer<?> keySerializer)` keySerializer used to convert keys into/from binary form.
`<K,V> HTreeMap<K,V>`	`make()`
`<K,V> HTreeMap<K,V>`	`makeOrGet()`
`<K> DB.HTreeMapMaker`	`pumpIgnoreDuplicates()` If source iteretor contains an duplicate key, exception is thrown.
`DB.HTreeMapMaker`	`pumpPresort(int batchSize)`
`<K,V> DB.HTreeMapMaker`	`pumpSource(Iterator<Fun.Pair<K,V>> entriesSource)`
`<K,V> DB.HTreeMapMaker`	`pumpSource(Iterator<K> keysSource, Fun.Function1<V,K> valueExtractor)`
`DB.HTreeMapMaker`	`valueCreator(Fun.Function1<?,?> valueCreator)` If value is not found, HTreeMap can fetch and insert default value.
`DB.HTreeMapMaker`	`valueSerializer(Serializer<?> valueSerializer)` valueSerializer used to convert values into/from binary form.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - db
```
protected final DB db
```
  - name
```
protected final String name
```
  - engines
```
protected final Engine[] engines
```
  - counter
```
protected boolean counter
```
  - keySerializer
```
protected Serializer<?> keySerializer
```
  - valueSerializer
```
protected Serializer<?> valueSerializer
```
  - expireMaxSize
```
protected long expireMaxSize
```
  - expire
```
protected long expire
```
  - expireAccess
```
protected long expireAccess
```
  - expireStoreSize
```
protected long expireStoreSize
```
  - expireTick
```
protected long expireTick
```
  - ondisk
```
protected Bind.MapWithModificationListener ondisk
```
  - ondiskOverwrite
```
protected boolean ondiskOverwrite
```
  - valueCreator
```
protected Fun.Function1<?,?> valueCreator
```
  - pumpSource
```
protected Iterator pumpSource
```
  - pumpKeyExtractor
```
protected Fun.Function1 pumpKeyExtractor
```
  - pumpValueExtractor
```
protected Fun.Function1 pumpValueExtractor
```
  - pumpPresortBatchSize
```
protected int pumpPresortBatchSize
```
  - pumpIgnoreDuplicates
```
protected boolean pumpIgnoreDuplicates
```
  - closeEngine
```
protected boolean closeEngine
```
  - executor
```
protected ScheduledExecutorService executor
```
  - executorPeriod
```
protected long executorPeriod
```
- Constructor Detail
  - DB.HTreeMapMaker
```
public DB.HTreeMapMaker(DB db,
                String name,
                Engine[] engines)
```
- Method Detail
  - counterEnable
```
public DB.HTreeMapMaker counterEnable()
```
    by default collection does not have counter, without counter updates are faster, but entire collection needs to be traversed to count items.
  - keySerializer
```
public DB.HTreeMapMaker keySerializer(Serializer<?> keySerializer)
```
    keySerializer used to convert keys into/from binary form.
  - valueSerializer
```
public DB.HTreeMapMaker valueSerializer(Serializer<?> valueSerializer)
```
    valueSerializer used to convert values into/from binary form.
  - expireMaxSize
```
public DB.HTreeMapMaker expireMaxSize(long maxSize)
```
    maximal number of entries in this map. Less used entries will be expired and removed to make collection smaller
  - expireTick
```
public DB.HTreeMapMaker expireTick(long expireTick)
```
    Calling expiration cleanup too often reduces performance. This is minimal interval between cleanups. Larger value could cause OutOfMemoryError if values are not released fast enough. Default value is 1000ms
    
    Parameters:
    expireTick - minimal time between expiration cleanup in milliseconds
    
    Returns:
    this
  - expireAfterWrite
```
public DB.HTreeMapMaker expireAfterWrite(long interval,
                                TimeUnit timeUnit)
```
    Specifies that each entry should be automatically removed from the map once a fixed duration has elapsed after the entry's creation, or the most recent replacement of its value.
  - expireAfterWrite
```
public DB.HTreeMapMaker expireAfterWrite(long interval)
```
    Specifies that each entry should be automatically removed from the map once a fixed duration has elapsed after the entry's creation, or the most recent replacement of its value.
  - expireAfterAccess
```
public DB.HTreeMapMaker expireAfterAccess(long interval,
                                 TimeUnit timeUnit)
```
    Specifies that each entry should be automatically removed from the map once a fixed duration has elapsed after the entry's creation, the most recent replacement of its value, or its last access. Access time is reset by all map read and write operations
  - expireAfterAccess
```
public DB.HTreeMapMaker expireAfterAccess(long interval)
```
    Specifies that each entry should be automatically removed from the map once a fixed duration has elapsed after the entry's creation, the most recent replacement of its value, or its last access. Access time is reset by all map read and write operations
  - expireStoreSize
```
public DB.HTreeMapMaker expireStoreSize(double maxStoreSize)
```
    maximal size of store in GB, if store is larger entries will start expiring
  - expireOverflow
```
public DB.HTreeMapMaker expireOverflow(Bind.MapWithModificationListener ondisk,
                              boolean overwrite)
```
    After expiration (or deletion), put entries into given map
    
    Parameters:
    ondisk - Map populated with data after expiration
    overwrite - if true any data in onDisk will be overwritten. If false only non-existing keys will be inserted (put() versus putIfAbsent();
    
    Returns:
    this builder
  - valueCreator
```
public DB.HTreeMapMaker valueCreator(Fun.Function1<?,?> valueCreator)
```
    If value is not found, HTreeMap can fetch and insert default value. valueCreator is used to return new value. This way HTreeMap.get() never returns null
  - pumpSource
```
public <K,V> DB.HTreeMapMaker pumpSource(Iterator<K> keysSource,
                                Fun.Function1<V,K> valueExtractor)
```
  - pumpSource
```
public <K,V> DB.HTreeMapMaker pumpSource(Iterator<Fun.Pair<K,V>> entriesSource)
```
  - pumpPresort
```
public DB.HTreeMapMaker pumpPresort(int batchSize)
```
  - executorEnable
```
public DB.HTreeMapMaker executorEnable()
```
  - executorEnable
```
public DB.HTreeMapMaker executorEnable(ScheduledExecutorService executor)
```
  - executorPeriod
```
public DB.HTreeMapMaker executorPeriod(long period)
```
  - pumpIgnoreDuplicates
```
public <K> DB.HTreeMapMaker pumpIgnoreDuplicates()
```
    If source iteretor contains an duplicate key, exception is thrown. This options will only use firts key and ignore any consequentive duplicates.
  - closeEngine
```
protected DB.HTreeMapMaker closeEngine()
```
  - make
```
public <K,V> HTreeMap<K,V> make()
```
  - makeOrGet
```
public <K,V> HTreeMap<K,V> makeOrGet()
```

Class DB.HTreeMapMaker

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

db

name

engines

counter

keySerializer

valueSerializer

expireMaxSize

expire

expireAccess

expireStoreSize

expireTick

ondisk

ondiskOverwrite

valueCreator

pumpSource

pumpKeyExtractor

pumpValueExtractor

pumpPresortBatchSize

pumpIgnoreDuplicates

closeEngine

executor

executorPeriod

Constructor Detail

DB.HTreeMapMaker

Method Detail

counterEnable

keySerializer

valueSerializer

expireMaxSize

expireTick

expireAfterWrite

expireAfterWrite

expireAfterAccess

expireAfterAccess

expireStoreSize

expireOverflow

valueCreator

pumpSource

pumpSource

pumpPresort

executorEnable

executorEnable

executorPeriod

pumpIgnoreDuplicates

closeEngine

make

makeOrGet