InMemoryBTreeConfiguration

java.lang.Object
- org.apache.directory.mavibot.btree.InMemoryBTreeConfiguration<K,V>

Type Parameters:

K - The type for the keys

V - The type for the stored values
```
public class InMemoryBTreeConfiguration<K,V>
extends java.lang.Object
```
The B+Tree Configuration. This class can be used to store all the configurable parameters used by the BTree class

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`allowDuplicates` Flag to enable duplicate key support
`private long`	`checkPointDelay` The delay between two checkpoints.
`private java.lang.String`	`filePath` The path where the BTree file will be stored.
`private java.lang.String`	`journalName` The journal's name.
`private long`	`journalSize` The maximal size of the journal.
`private ElementSerializer<K>`	`keySerializer` The Key and Value serializer used for this tree.
`private java.lang.String`	`name` The BTree name
`private int`	`pageSize` Number of entries in each Page.
`private long`	`readTimeOut` The maximum delay to wait before a revision is considered as unused.
`private BTreeTypeEnum`	`type` the type of BTree
`private ElementSerializer<V>`	`valueSerializer`
`private int`	`writeBufferSize` The size of the buffer used to write data in disk

Constructor Summary

Constructors
Constructor and Description

InMemoryBTreeConfiguration()

Constructors
Constructor and Description
`InMemoryBTreeConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getCheckPointDelay()`
`java.lang.String`	`getFilePath()`
`java.lang.String`	`getJournalName()`
`long`	`getJournalSize()`
`ElementSerializer<K>`	`getKeySerializer()`
`java.lang.String`	`getName()`
`int`	`getPageSize()`
`long`	`getReadTimeOut()`
`BTreeTypeEnum`	`getType()`
`ElementSerializer<V>`	`getValueSerializer()`
`int`	`getWriteBufferSize()`
`boolean`	`isAllowDuplicates()`
`void`	`setAllowDuplicates(boolean allowDuplicates)` enable duplicate key support
`void`	`setCheckPointDelay(long checkPointDelay)`
`void`	`setFilePath(java.lang.String filePath)`
`void`	`setJournalName(java.lang.String journalName)`
`void`	`setJournalSize(long journalSize)`
`void`	`setKeySerializer(ElementSerializer<K> keySerializer)`
`void`	`setName(java.lang.String name)`
`void`	`setPageSize(int pageSize)`
`void`	`setReadTimeOut(long readTimeOut)`
`void`	`setSerializers(ElementSerializer<K> keySerializer, ElementSerializer<V> valueSerializer)`
`void`	`setType(BTreeTypeEnum type)` Sets the type of the BTree
`void`	`setValueSerializer(ElementSerializer<V> valueSerializer)`
`void`	`setWriteBufferSize(int writeBufferSize)`

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

- Field Detail
  - pageSize
```
private int pageSize
```
    Number of entries in each Page.
  - writeBufferSize
```
private int writeBufferSize
```
    The size of the buffer used to write data in disk
  - keySerializer
```
private ElementSerializer<K> keySerializer
```
    The Key and Value serializer used for this tree. If none is provided, the BTree will deduce the serializer to use from the generic type, and use the default Java serialization
  - valueSerializer
```
private ElementSerializer<V> valueSerializer
```
  - name
```
private java.lang.String name
```
    The BTree name
  - filePath
```
private java.lang.String filePath
```
    The path where the BTree file will be stored. Default to the local temporary directory.
  - readTimeOut
```
private long readTimeOut
```
    The maximum delay to wait before a revision is considered as unused. This delay is necessary so that a read that does not ends does not hold a revision in memory forever. The default value is 10000 (10 seconds). If the value is 0 or below, the delay is considered as infinite
  - journalSize
```
private long journalSize
```
    The maximal size of the journal. When this size is reached, the tree is flushed on disk. The default size is 10 Mb
  - journalName
```
private java.lang.String journalName
```
    The journal's name. Default to "mavibot.log".
  - checkPointDelay
```
private long checkPointDelay
```
    The delay between two checkpoints. When we reach the maximum delay, the BTree is flushed on disk, but only if we have had some modifications. The default value is 60 seconds.
  - allowDuplicates
```
private boolean allowDuplicates
```
    Flag to enable duplicate key support
  - type
```
private BTreeTypeEnum type
```
    the type of BTree
- Constructor Detail
  - InMemoryBTreeConfiguration
```
public InMemoryBTreeConfiguration()
```
- Method Detail
  - getPageSize
```
public int getPageSize()
```
    Returns:
    
    the pageSize
  - setPageSize
```
public void setPageSize(int pageSize)
```
    Parameters:
    
    pageSize - the pageSize to set
  - getKeySerializer
```
public ElementSerializer<K> getKeySerializer()
```
    Returns:
    
    the key serializer
  - getValueSerializer
```
public ElementSerializer<V> getValueSerializer()
```
    Returns:
    
    the value serializer
  - setSerializers
```
public void setSerializers(ElementSerializer<K> keySerializer,
                           ElementSerializer<V> valueSerializer)
```
    Parameters:
    
    keySerializer - the key serializer to set
    
    valueSerializer - the value serializer to set
  - setKeySerializer
```
public void setKeySerializer(ElementSerializer<K> keySerializer)
```
    Parameters:
    
    serializer - the key serializer to set
  - setValueSerializer
```
public void setValueSerializer(ElementSerializer<V> valueSerializer)
```
    Parameters:
    
    serializer - the key serializer to set
  - getReadTimeOut
```
public long getReadTimeOut()
```
    Returns:
    
    the readTimeOut
  - setReadTimeOut
```
public void setReadTimeOut(long readTimeOut)
```
    Parameters:
    
    readTimeOut - the readTimeOut to set
  - getJournalSize
```
public long getJournalSize()
```
    Returns:
    
    the journalSize
  - setJournalSize
```
public void setJournalSize(long journalSize)
```
    Parameters:
    
    journalSize - the journalSize to set
  - getCheckPointDelay
```
public long getCheckPointDelay()
```
    Returns:
    
    the checkPointDelay
  - setCheckPointDelay
```
public void setCheckPointDelay(long checkPointDelay)
```
    Parameters:
    
    checkPointDelay - the checkPointDelay to set
  - getFilePath
```
public java.lang.String getFilePath()
```
    Returns:
    
    the filePath
  - setFilePath
```
public void setFilePath(java.lang.String filePath)
```
    Parameters:
    
    filePath - the filePath to set
  - getJournalName
```
public java.lang.String getJournalName()
```
    Returns:
    
    the journal name
  - setJournalName
```
public void setJournalName(java.lang.String journalName)
```
    Parameters:
    
    journalName - the journal name to set
  - getWriteBufferSize
```
public int getWriteBufferSize()
```
    Returns:
    
    the writeBufferSize
  - setWriteBufferSize
```
public void setWriteBufferSize(int writeBufferSize)
```
    Parameters:
    
    writeBufferSize - the writeBufferSize to set
  - getName
```
public java.lang.String getName()
```
    Returns:
    
    the name
  - setName
```
public void setName(java.lang.String name)
```
    Parameters:
    
    name - the name to set
  - isAllowDuplicates
```
public boolean isAllowDuplicates()
```
    Returns:
    
    true if duplicate key support is enabled
  - setAllowDuplicates
```
public void setAllowDuplicates(boolean allowDuplicates)
```
    enable duplicate key support
    
    Parameters:
    
    allowDuplicates -
    
    Throws:
    
    java.lang.IllegalStateException - if the btree was already initialized or when tried to turn off duplicate suport on an existing btree containing duplicate keys
  - getType
```
public BTreeTypeEnum getType()
```
    Returns:
    
    the type of BTree
  - setType
```
public void setType(BTreeTypeEnum type)
```
    Sets the type of the BTree
    
    Parameters:
    
    type - the type of the tree

Class InMemoryBTreeConfiguration<K,V>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

pageSize

writeBufferSize

keySerializer

valueSerializer

name

filePath

readTimeOut

journalSize

journalName

checkPointDelay

allowDuplicates

type

Constructor Detail

InMemoryBTreeConfiguration

Method Detail

getPageSize

setPageSize

getKeySerializer

getValueSerializer

setSerializers

setKeySerializer

setValueSerializer

getReadTimeOut

setReadTimeOut

getJournalSize

setJournalSize

getCheckPointDelay

setCheckPointDelay

getFilePath

setFilePath

getJournalName

setJournalName

getWriteBufferSize

setWriteBufferSize

getName

setName

isAllowDuplicates

setAllowDuplicates

getType

setType