PersistedBTreeConfiguration

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

Type Parameters:

K - The type for the keys

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

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`allowDuplicates` Flag to enable duplicate key support
`private BTreeTypeEnum`	`btreeType` The B-tree type
`private int`	`cacheSize` The cache size, if it's <= 0, we don't have cache
`private java.lang.String`	`filePath` The path where the B-tree file will be stored.
`private ElementSerializer<K>`	`keySerializer` The Key and Value serializer used for this tree.
`private java.lang.String`	`name` The B-tree name
`private int`	`pageSize` Number of entries in each Page.
`private BTree<?,V>`	`parentBTree` The inherited B-tree if we create a sub B-tree
`private long`	`readTimeOut` The maximum delay to wait before a revision is considered as unused.
`private ElementSerializer<V>`	`valueSerializer`
`private int`	`writeBufferSize` The size of the buffer used to write data in disk

Constructor Summary

Constructors
Constructor and Description

PersistedBTreeConfiguration()

Constructors
Constructor and Description
`PersistedBTreeConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BTreeTypeEnum`	`getBtreeType()`
`int`	`getCacheSize()`
`java.lang.String`	`getFilePath()`
`ElementSerializer<K>`	`getKeySerializer()`
`java.lang.String`	`getName()`
`int`	`getPageSize()`
`BTree<?,V>`	`getParentBTree()`
`long`	`getReadTimeOut()`
`ElementSerializer<V>`	`getValueSerializer()`
`int`	`getWriteBufferSize()`
`boolean`	`isAllowDuplicates()`
`void`	`setAllowDuplicates(boolean allowDuplicates)` enable duplicate key support
`void`	`setBtreeType(BTreeTypeEnum btreeType)`
`void`	`setCacheSize(int cacheSize)`
`void`	`setFilePath(java.lang.String filePath)`
`void`	`setKeySerializer(ElementSerializer<K> keySerializer)`
`void`	`setName(java.lang.String name)`
`void`	`setPageSize(int pageSize)`
`void`	`setParentBTree(BTree<?,V> parentBTree)`
`void`	`setReadTimeOut(long readTimeOut)`
`void`	`setSerializers(ElementSerializer<K> keySerializer, ElementSerializer<V> valueSerializer)`
`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 B-tree 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 B-tree name
  - filePath
```
private java.lang.String filePath
```
    The path where the B-tree 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
  - allowDuplicates
```
private boolean allowDuplicates
```
    Flag to enable duplicate key support
  - btreeType
```
private BTreeTypeEnum btreeType
```
    The B-tree type
  - cacheSize
```
private int cacheSize
```
    The cache size, if it's <= 0, we don't have cache
  - parentBTree
```
private BTree<?,V> parentBTree
```
    The inherited B-tree if we create a sub B-tree
- Constructor Detail
  - PersistedBTreeConfiguration
```
public PersistedBTreeConfiguration()
```
- 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
  - getFilePath
```
public java.lang.String getFilePath()
```
    Returns:
    
    the filePath
  - setFilePath
```
public void setFilePath(java.lang.String filePath)
```
    Parameters:
    
    filePath - the filePath 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 B-tree was already initialized or when tried to turn off duplicate suport on an existing B-tree containing duplicate keys
  - getCacheSize
```
public int getCacheSize()
```
    Returns:
    
    the cacheSize
  - setCacheSize
```
public void setCacheSize(int cacheSize)
```
    Parameters:
    
    cacheSize - the cacheSize to set.
  - getParentBTree
```
public BTree<?,V> getParentBTree()
```
    Returns:
    
    the cache
  - setParentBTree
```
public void setParentBTree(BTree<?,V> parentBTree)
```
    Parameters:
    
    cache - the cache to set.
  - getBtreeType
```
public BTreeTypeEnum getBtreeType()
```
    Returns:
    
    The BtreeType for this Btree
  - setBtreeType
```
public void setBtreeType(BTreeTypeEnum btreeType)
```
    Parameters:
    
    btreeType - The BtreeType

Class PersistedBTreeConfiguration<K,V>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

pageSize

writeBufferSize

keySerializer

valueSerializer

name

filePath

readTimeOut

allowDuplicates

btreeType

cacheSize

parentBTree

Constructor Detail

PersistedBTreeConfiguration

Method Detail

getPageSize

setPageSize

getKeySerializer

getValueSerializer

setSerializers

setKeySerializer

setValueSerializer

getReadTimeOut

setReadTimeOut

getFilePath

setFilePath

getWriteBufferSize

setWriteBufferSize

getName

setName

isAllowDuplicates

setAllowDuplicates

getCacheSize

setCacheSize

getParentBTree

setParentBTree

getBtreeType

setBtreeType