Class RowConverter

Provides methods for Row to/from BSONDocument conversion

Inheritance
System.Object
RowConverter
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: NFX.Serialization.BSON
Assembly: NFX.dll
Syntax
public class RowConverter : IConfigurable

Constructors

RowConverter()

Declaration
public RowConverter()

Fields

DECIMAL_LONG_MUL

Declaration
public const decimal DECIMAL_LONG_MUL = 1000M
Field Value
Type Description
System.Decimal

m_BSONtoCLR

Declaration
protected Dictionary<Type, Func<BSONElement, object>> m_BSONtoCLR
Field Value
Type Description
System.Collections.Generic.Dictionary<System.Type, System.Func<BSONElement, System.Object>>

m_CLRtoBSON

Declaration
protected Dictionary<Type, Func<string, object, BSONElement>> m_CLRtoBSON
Field Value
Type Description
System.Collections.Generic.Dictionary<System.Type, System.Func<System.String, System.Object, BSONElement>>

MAX_BYTE_BUFFER_SIZE

Maximum size of a byte[] field. Large filed (> 12Mbyte) should not be stored as fields in the database

Declaration
public const int MAX_BYTE_BUFFER_SIZE = 12582912
Field Value
Type Description
System.Int32

MAX_DECIMAL

Declaration
public const decimal MAX_DECIMAL = 9223372036854775.807M
Field Value
Type Description
System.Decimal

MIN_DECIMAL

Declaration
public const decimal MIN_DECIMAL = -9223372036854775.808M
Field Value
Type Description
System.Decimal

s_BSONtoCLR

Declaration
protected static Dictionary<Type, Func<BSONElement, object>> s_BSONtoCLR
Field Value
Type Description
System.Collections.Generic.Dictionary<System.Type, System.Func<BSONElement, System.Object>>

s_CLRtoBSON

Declaration
protected static Dictionary<Type, Func<string, object, BSONElement>> s_CLRtoBSON
Field Value
Type Description
System.Collections.Generic.Dictionary<System.Type, System.Func<System.String, System.Object, BSONElement>>

Properties

DefaultInstance

Returns the default instance

Declaration
public static RowConverter DefaultInstance { get; }
Property Value
Type Description
RowConverter

Methods

Amount_BSONtoCLR(BSONDocumentElement)

Declaration
public static Amount Amount_BSONtoCLR(BSONDocumentElement el)
Parameters
Type Name Description
BSONDocumentElement el
Returns
Type Description
Amount

Amount_CLRtoBSON(String, Amount)

Declaration
public static BSONDocumentElement Amount_CLRtoBSON(string name, Amount amount)
Parameters
Type Name Description
System.String name
Amount amount
Returns
Type Description
BSONDocumentElement

BSONDocumentToJSONMap(BSONDocument, Func<BSONDocument, BSONElement, Boolean>)

Converts BSON document to JSON data map by directly mapping BSON types into corresponding CLR types. The sub-documents get mapped into JSONDataObjects, and BSON arrays get mapped into CLR object[]

Declaration
public virtual JSONDataMap BSONDocumentToJSONMap(BSONDocument doc, Func<BSONDocument, BSONElement, bool> filter = null)
Parameters
Type Name Description
BSONDocument doc
System.Func<BSONDocument, BSONElement, System.Boolean> filter
Returns
Type Description
JSONDataMap

BSONDocumentToRow(BSONDocument, Row, String, Boolean, Func<BSONDocument, BSONElement, Boolean>)

Converts BSON document into Row by filling the supplied row instance making necessary type transforms to suit Row.Schema field definitions per target name. If the passed row supports IAmorphousData, then the fields either not found in row, or the fields that could not be type-converted to CLR type will be stowed in amorphous data dictionary

Declaration
public virtual void BSONDocumentToRow(BSONDocument doc, Row row, string targetName, bool useAmorphousData = true, Func<BSONDocument, BSONElement, bool> filter = null)
Parameters
Type Name Description
BSONDocument doc
Row row
System.String targetName
System.Boolean useAmorphousData
System.Func<BSONDocument, BSONElement, System.Boolean> filter

ByteBuffer_CLRtoBSON(String, Byte[])

Declaration
public static BSONElement ByteBuffer_CLRtoBSON(string name, byte[] buf)
Parameters
Type Name Description
System.String name
System.Byte[] buf
Returns
Type Description
BSONElement

ByteBufferID_CLRtoBSON(String, Byte[])

Encodes byte buffer purposed for id, using proper binary subtype

Declaration
public static BSONElement ByteBufferID_CLRtoBSON(string name, byte[] buf)
Parameters
Type Name Description
System.String name
System.Byte[] buf
Returns
Type Description
BSONElement

Configure(IConfigSectionNode)

Declaration
public virtual void Configure(IConfigSectionNode node)
Parameters
Type Name Description
IConfigSectionNode node

ConvertCLRtoBSON(String, Object, String)

Converts CLR value to BSON. The following values are supported: primitives+scaled decimal, enums, TypedRows, GDID, Guid, Amount, IDictionary, IEnumerable (including arrays). If conversion could not be made then exception is thrown

Declaration
public BSONElement ConvertCLRtoBSON(string fieldName, object data, string targetName)
Parameters
Type Name Description
System.String fieldName
System.Object data
System.String targetName
Returns
Type Description
BSONElement

Decimal_BSONtoCLR(BSONElement)

Declaration
public static decimal Decimal_BSONtoCLR(BSONElement el)
Parameters
Type Name Description
BSONElement el
Returns
Type Description
System.Decimal

Decimal_BSONtoCLR(BSONInt32Element)

Declaration
public static decimal Decimal_BSONtoCLR(BSONInt32Element el)
Parameters
Type Name Description
BSONInt32Element el
Returns
Type Description
System.Decimal

Decimal_BSONtoCLR(BSONInt64Element)

Declaration
public static decimal Decimal_BSONtoCLR(BSONInt64Element el)
Parameters
Type Name Description
BSONInt64Element el
Returns
Type Description
System.Decimal

Decimal_CLRtoBSON(String, Decimal)

Declaration
public static BSONInt64Element Decimal_CLRtoBSON(string name, decimal v)
Parameters
Type Name Description
System.String name
System.Decimal v
Returns
Type Description
BSONInt64Element

DirectConvertBSONValue(BSONElement, Func<BSONDocument, BSONElement, Boolean>)

Converts BSON to CLR value 1:1, without type change

Declaration
protected virtual object DirectConvertBSONValue(BSONElement element, Func<BSONDocument, BSONElement, bool> filter = null)
Parameters
Type Name Description
BSONElement element
System.Func<BSONDocument, BSONElement, System.Boolean> filter
Returns
Type Description
System.Object

DoConvertCLRtoBSON(String, Object, Type, String)

override to perform the conversion. the data is never null here, and ref cycles a ruled out

Declaration
protected virtual BSONElement DoConvertCLRtoBSON(string name, object data, Type dataType, string targetName)
Parameters
Type Name Description
System.String name
System.Object data
System.Type dataType
System.String targetName
Returns
Type Description
BSONElement

GDID_BSONtoCLR(BSONBinaryElement)

Declaration
public static GDID GDID_BSONtoCLR(BSONBinaryElement el)
Parameters
Type Name Description
BSONBinaryElement el
Returns
Type Description
GDID

GDID_CLRtoBSON(String, GDID)

Declaration
public static BSONElement GDID_CLRtoBSON(string name, GDID gdid)
Parameters
Type Name Description
System.String name
GDID gdid
Returns
Type Description
BSONElement

GDID_CLRtoBSONBinary(GDID)

Declaration
public static BSONBinary GDID_CLRtoBSONBinary(GDID gdid)
Parameters
Type Name Description
GDID gdid
Returns
Type Description
BSONBinary

GetAmorphousFieldAsBSON(KeyValuePair<String, Object>, String)

Declaration
protected virtual BSONElement GetAmorphousFieldAsBSON(KeyValuePair<string, object> field, string targetName)
Parameters
Type Name Description
System.Collections.Generic.KeyValuePair<System.String, System.Object> field
System.String targetName
Returns
Type Description
BSONElement

GetFieldAsBSON(Row, Schema.FieldDef, String)

Declaration
protected virtual BSONElement GetFieldAsBSON(Row row, Schema.FieldDef field, string targetName)
Parameters
Type Name Description
Row row
Schema.FieldDef field
System.String targetName
Returns
Type Description
BSONElement

GUID_BSONtoCLR(BSONBinaryElement)

Declaration
public static Guid GUID_BSONtoCLR(BSONBinaryElement el)
Parameters
Type Name Description
BSONBinaryElement el
Returns
Type Description
System.Guid

GUID_CLRtoBSON(String, Guid)

Declaration
public static BSONElement GUID_CLRtoBSON(string name, Guid guid)
Parameters
Type Name Description
System.String name
System.Guid guid
Returns
Type Description
BSONElement

InferSchemaFromBSONDocument(BSONDocument, String)

Makes CRUD Schema out of BSON document. The types of all fields are object as documents do not have a predictable type of every field (they are dynamic and can change form doc to doc)

Declaration
public virtual Schema InferSchemaFromBSONDocument(BSONDocument doc, string schemaName = null)
Parameters
Type Name Description
BSONDocument doc
System.String schemaName
Returns
Type Description
Schema

MapBSONFieldNameToSchemaFieldDef(Schema, String, String)

Maps bsonFieldName to targeted fieldDef from specified schema using cache for TypedRows

Declaration
protected static Schema.FieldDef MapBSONFieldNameToSchemaFieldDef(Schema schema, string targetName, string bsonFieldName)
Parameters
Type Name Description
Schema schema
System.String targetName
System.String bsonFieldName
Returns
Type Description
Schema.FieldDef

RowToBSONDocument(Row, String, Boolean, FieldFilterFunc)

Converts row to BSON document suitable for storage in MONGO.DB. Pass target name (name of particular store/epoch/implementation) to get targeted field metadata. Note: the supplied row MAY NOT CONTAIN REFERENCE CYCLES - either direct or transitive

Declaration
public virtual BSONDocument RowToBSONDocument(Row row, string targetName, bool useAmorphousData = true, FieldFilterFunc filter = null)
Parameters
Type Name Description
Row row
System.String targetName
System.Boolean useAmorphousData
FieldFilterFunc filter
Returns
Type Description
BSONDocument

RowToBSONDocumentElement(Row, String, Boolean, String, FieldFilterFunc)

Converts row to BSON document suitable for storage in MONGO.DB. Pass target name (name of particular store/epoch/implementation) to get targeted field metadata. Note: the supplied row MAY NOT CONTAIN REFERENCE CYCLES - either direct or transitive

Declaration
public virtual BSONDocumentElement RowToBSONDocumentElement(Row row, string targetName, bool useAmorphousData = true, string name = null, FieldFilterFunc filter = null)
Parameters
Type Name Description
Row row
System.String targetName
System.Boolean useAmorphousData
System.String name
FieldFilterFunc filter
Returns
Type Description
BSONDocumentElement

SetAmorphousFieldAsCLR(IAmorphousData, BSONElement, String, Func<BSONDocument, BSONElement, Boolean>)

Declaration
protected virtual bool SetAmorphousFieldAsCLR(IAmorphousData amorph, BSONElement bsonElement, string targetName, Func<BSONDocument, BSONElement, bool> filter)
Parameters
Type Name Description
IAmorphousData amorph
BSONElement bsonElement
System.String targetName
System.Func<BSONDocument, BSONElement, System.Boolean> filter
Returns
Type Description
System.Boolean

String_CLRtoBSON(String, String)

Declaration
public static BSONElement String_CLRtoBSON(string name, string str)
Parameters
Type Name Description
System.String name
System.String str
Returns
Type Description
BSONElement

TryConvertBSONtoCLR(Type, BSONElement, String, out Object, Func<BSONDocument, BSONElement, Boolean>)

Tries to convert the BSON value into target CLR type. Returns true if conversion was successfull

Declaration
protected virtual bool TryConvertBSONtoCLR(Type target, BSONElement element, string targetName, out object clrValue, Func<BSONDocument, BSONElement, bool> filter)
Parameters
Type Name Description
System.Type target
BSONElement element
System.String targetName
System.Object clrValue
System.Func<BSONDocument, BSONElement, System.Boolean> filter
Returns
Type Description
System.Boolean

TrySetFieldAsCLR(Row, Schema.FieldDef, BSONElement, String, Func<BSONDocument, BSONElement, Boolean>)

Declaration
protected virtual bool TrySetFieldAsCLR(Row row, Schema.FieldDef field, BSONElement value, string targetName, Func<BSONDocument, BSONElement, bool> filter)
Parameters
Type Name Description
Row row
Schema.FieldDef field
BSONElement value
System.String targetName
System.Func<BSONDocument, BSONElement, System.Boolean> filter
Returns
Type Description
System.Boolean

Implements

Extension Methods