Click or drag to resize

BTreeMapBaseKey, Value Class

Represents a collection of objects that is maintained in sorted order.
Inheritance Hierarchy
SystemObject
  VelocityDbOptimizedPersistable
    VelocityDb.Collection.BTreeBTreeNode
      VelocityDb.Collection.BTreeBTreeBaseKey, Value
        VelocityDb.Collection.BTreeBTreeMapBaseKey, Value
          VelocityDb.Collection.BTreeBTreeMapKey, Value
          VelocityDb.Collection.BTreeBTreeMapOidShortKey, Value

Namespace:  VelocityDb.Collection.BTree
Assembly:  VelocityDb (in VelocityDb.dll) Version: 11.1.0.0 (11.1)
Syntax
[SerializableAttribute]
public abstract class BTreeMapBase<Key, Value> : BTreeBase<Key, Value>, 
	IEnumerable<KeyValuePair<Key, Value>>, IEnumerable, IEnumerable<Key>

Type Parameters

Key
The type of key objects in this BTree
Value
The type of value objects in a BTreeMap or BTreeMapOidShort

The BTreeMapBaseKey, Value type exposes the following members.

Properties
  NameDescription
Public propertyItem
Given a lookup key, returns the corresponding value within the map or null if not found
Public propertyTransientBatchSize
Get/Set the max batch size used in API such as AddFast(Key)
(Overrides BTreeBaseKey, ValueTransientBatchSize.)
Public propertyValuePlacement
Set the value placement to be used for all value objects added to this. This setting is not persisted, it is mainly to be used with objects added with AddFast(Key, Value)
Public propertyValues
Gets a collection containing the values of this object
Top
Methods
  NameDescription
Public methodAddFast
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 commited and/or flushed to disk or when the array is full. The array size is by default currently [!:BTreeBase<Key, Value>.transientBatchBufferDefaultSize] but you can get/set the desired size with TransientBatchSize
Public methodEnumerateValues
Enumerates all contained Value objects in corresponding key sorted order
Public methodFlushTransients
Adds all queued up to be added objects after presorting them transiently
(Overrides BTreeBaseKey, ValueFlushTransients.)
Public methodGetEnumerator
Enumerates all contained Key objects in sorted order
Public methodGetValueId(Key)
When Value 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.
Public methodGetValueId(Key, Byte)
When Value 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.
Public methodIterator
Initializes an iterator to find the keys and values of this map
Public methodLast
Returns the last KeyValue object in this set.
Public methodLastValue
Returns the last value in this map.
Public methodTryGetValue(Key, Value)
Gets the value associated with the specified key.
Public methodTryGetValue(Key, Byte, Value)
Gets the value associated with the specified key.
Top
Extension Methods
  NameDescription
Public Extension MethodToStringDetails(SessionBase, Boolean)Overloaded.
Object details as a string
(Defined by Utilities.)
Public Extension MethodToStringDetails(Schema, TypeVersion, Boolean)Overloaded.
Currently only used by Database Manager
(Defined by Utilities.)
Top
See Also