CompareByField<Key> Class |
Use this predefined comparator whenever the sorting can be defined by specifying one or more fields of the sorted Key type.
Inheritance HierarchySystem.Object
VelocityDb.OptimizedPersistable
VelocityDb.Collection.Comparer.VelocityDbComparer<Key>
VelocityDb.Collection.Comparer.CompareByField<Key>
VelocityDb.Collection.Comparer.CompareByFieldIndex<Key>
VelocityDb.OptimizedPersistable
VelocityDb.Collection.Comparer.VelocityDbComparer<Key>
VelocityDb.Collection.Comparer.CompareByField<Key>
VelocityDb.Collection.Comparer.CompareByFieldIndex<Key>
Namespace: VelocityDb.Collection.Comparer
Assembly: VelocityDb (in VelocityDb.dll) Version: 11.1.0.0 (11.1)
SyntaxType Parameters
- Key
- The type of object being compared (containing field(s) to compare)
The CompareByField<Key> type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CompareByField<Key>(SessionBase) |
This special constructor is provided so that VelocityDb can instantiate the object after reading it from disk.
This is also the place to initialize transient variables of the object.
|
| CompareByField<Key>(String, SessionBase, Boolean, Boolean, Boolean) |
Compares objects by comparing one or more data fields of type Key
|
Properties| Name | Description | |
|---|---|---|
 | AddOidCompare |
Is the object Oid going to be compared when all the compared fields are equal?
(Overrides VelocityDbComparer<Key>.AddOidCompare.) |
| FieldsToCompare | |
| OidPartOfComparisonBytes |
Is the Oid (or OidShort) included in the comparison array bytes?
(Overrides VelocityDbComparer<Key>.OidPartOfComparisonBytes.) |
Methods| Name | Description | |
|---|---|---|
| AddFieldToCompare |
Add an additional field to compare when prior fields all are equal
|
| Compare(Key, Key) |
Compares field(s) of Key a with field(s) of Key b
(Overrides VelocityDbComparer<Key>.Compare(Key, Key).) |
| Compare(Byte[], Int32,Byte[], Key) | (Overrides VelocityDbComparer<Key>.Compare(Byte[], Int32,Byte[], Key).) |
| CompareField |
For internal use. Compares a field value in two objects
|
 | GetHashCode32 |
Microsoft messed up the 64 bit version of GetHashCode. Use this original 32-bit version to get consistent String hash codes across 32 bit and 64 bit builds.
See remarks in https://msdn.microsoft.com/en-us/library/system.string.gethashcode(v=vs.110).aspx
|
| 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 OptimizedPersistable.InitializeAfterRecreate(SessionBase).) |
| SetComparisonArrayFromObject |
Sets a byte array equivalent to the field values to compare. Using this bypasses object compares, instead the byte arrays are compared byte by byte until a diff is found. If a byte diff isn't found then object compares may happen.
Field types currently supported: byte, bool, Char, string, Int16, Int32, Int64, UInt16, UInt32, UInt64, Single, Double, DateTime, TimeSpan
(Overrides VelocityDbComparer<Key>.SetComparisonArrayFromObject(Key,Byte[], Boolean).) |
| SetupFieldsToCompare |
Initializes data used to compare fields as specified with this comparer.
|
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