BTreeBaseKey, Value Class |
Represents a collection of objects that is maintained in sorted order.
Inheritance HierarchySystemObject
VelocityDbOptimizedPersistable
VelocityDb.Collection.BTreeBTreeNode
VelocityDb.Collection.BTreeBTreeBaseKey, Value
VelocityDb.Collection.BTreeBTreeMapBaseKey, Value
VelocityDb.Collection.BTreeBTreeSetKey
VelocityDb.Collection.BTreeBTreeSetOidShortKey
VelocityDbOptimizedPersistable
VelocityDb.Collection.BTreeBTreeNode
VelocityDb.Collection.BTreeBTreeBaseKey, Value
VelocityDb.Collection.BTreeBTreeMapBaseKey, Value
VelocityDb.Collection.BTreeBTreeSetKey
VelocityDb.Collection.BTreeBTreeSetOidShortKey
Namespace: VelocityDb.Collection.BTree
Assembly: VelocityDb (in VelocityDb.dll) Version: 11.1.0.0 (11.1)
Syntax[SerializableAttribute] public abstract class BTreeBase<Key, Value> : BTreeNode, IEnumerable<Key>, IEnumerable
Type Parameters
- Key
- The type of key objects in this BTree
- Value
- The type of value objects in a BTreeMap or BTreeMapOidShort
The BTreeBaseKey, Value type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Comparer |
Gets the VelocityDbComparer(Of Key) that is used to determine the order of the items in the sorted set
|
| ComparisonArraySize |
Gets the size of a comparison array used by this set.
|
| Count |
Gets the number of elements in the set.
|
| Depth |
Gets the depth of the BTreeSet
|
| FlushIfPageFull |
We don't want to flush other BTree pages while looking for a placement page
(Overrides OptimizedPersistableFlushIfPageFull.) |
| GetAlternateComparer |
If comparer isn't set then if Key type is string use SessionBase.DefaultStringComparer or ...
|
| IsLeaf |
Is the root a leaf node or not?
|
| KeyPlacement |
Set the key placement to be used for all key objects added to this. This setting is not persisted, it is mainly to be used with objects added with AddFast(Key) |
| NodeSize |
The size of the nodeList or the keyList (if depth is 1) of the root node.
|
| ObjectsPerPage |
Limit to 1000 per page (instead of default 40000)
(Overrides OptimizedPersistableObjectsPerPage.) |
| ToDoBatchAddCount |
Gets the number of objects that are not yet added to the collection
|
| TransientBatchSize |
Get/Set the max batch size used in API such as AddFast(Key) |
| UsesOidShort |
Does this BTree use short object references (32 bit) for its internal references?
|
Methods| Name | Description | |
|---|---|---|
 | Add(Key) |
Adds an element to the set and returns a value that indicates if it was successfully added
|
| Add(Key, Value) |
Add a key with an associated value to a BTreeMap
|
| Add(Key, Value, Byte) |
Adds a key and value to the map and returns a value that indicates if it was successfully added
|
| AddFast |
Adds an element to an array of to be added objects.
The objects in this array are added when a call toFlushTransients is triggered by multiple events such as calling Count and when collection is committed and/or flushed to disk or when the array is full.
The array size is by default currently BTreeAddFastTransientBatchSize but you can get/set the desired size with TransientBatchSize |
| AddWithComparisonArray |
Adds an element to the set and returns a value that indicates if it was successfully added
|
| Clear |
Removes all elements from the set.
|
| Contains(Key) |
Determines whether the set contains a specific element.
|
| Contains(Key, Byte) |
Determines whether the set contains a specific element.
|
| CopyTo |
Copies a range of elements from the BTreeBase to a compatible one-dimensional array, starting at the specified index of the target array.
|
| FlushTransients |
Adds all queued up to be added objects after presorting them transiently
(Overrides OptimizedPersistableFlushTransients.) |
| GetEnumerator |
Enumerates all contained Key objects in sorted order
|
| GetKeyId(Key) |
When Key type implements IOptimizedPersistable, you can use this function to get the Id of the persistent object instead of the entire object.
Use for performance reasons in certain cases where reading the object isn't desired. To avoid opening the object, a comparison array which is flagged as complete key must be used.
|
| GetKeyId(Key, Byte) |
When Key type implements IOptimizedPersistable, you can use this function to get the Id of the persistent object instead of the entire object.
Use for performance reasons in certain cases where reading the object isn't desired. To avoid opening the object, a comparison array which is flagged as complete key must be used.
|
| InitializeAfterRead |
Sets up some transient variables
(Overrides OptimizedPersistableInitializeAfterRead(SessionBase).) |
| InitializeAfterRecreate |
This function is called when an object has been read from disk before all data members (fields) have been fully loaded. Override this to provide your own initializations of transient data.
(Overrides OptimizedPersistableInitializeAfterRecreate(SessionBase).) |
| InitNew |
Internal use only
|
| Iterator |
Initializes an iterator to find the keys of this set
|
| Remove(Key) |
Removes a specified item from the set.
|
| Remove(Key, Byte) |
Removes a specified item from the set.
|
| SearchTransients | |
| TryGetKey(Key, Key) |
Gets the value matching persistent key with the specified key.
|
| TryGetKey(Key, Byte, Key) |
Gets the value associated with the specified key.
|
Extension Methods| Name | Description | |
|---|---|---|
 | ToStringDetails(SessionBase, Boolean) | Overloaded.
Object details as a string
(Defined by Utilities.) |
| ToStringDetails(Schema, TypeVersion, Boolean) | Overloaded.
Currently only used by Database Manager
(Defined by Utilities.) |
See Also