C# OJAI Client API
MapRDB.Driver.Ojai.IDocument Interface Reference
Inheritance diagram for MapRDB.Driver.Ojai.IDocument:
MapRDB.Driver.Ojai.OjaiDocument

Public Member Functions

string ToJsonString ()
 Parse document into JSON string. More...
 
string ToJsonString (Formatting formatting)
 Parse document into JSON string. More...
 
IDictionary< string, OjaiValueToDictionary ()
 Return document as dictionary. More...
 
IDocument SetID (string value)
 Set string ID of document. More...
 
IDocument SetID (byte[] value)
 Set binary ID of document. More...
 
IDocument Set (string path, string value)
 Set string value in document at given path. More...
 
IDocument Set (string path, bool value)
 Set bool value in document at given path. More...
 
IDocument Set (string path, byte value)
 Set byte value in document at given path. More...
 
IDocument Set (string path, short value)
 Set short value in document at given path. More...
 
IDocument Set (string path, int value)
 Set int value in document at given path. More...
 
IDocument Set (string path, long value)
 Set long value in document at given path. More...
 
IDocument Set (string path, float value)
 Set float value in document at given path. More...
 
IDocument Set (string path, double value)
 Set double value in document at given path. More...
 
IDocument Set (string path, decimal value)
 Set decimal value in document at given path. More...
 
IDocument SetNull (string path)
 Set null value in document at given path. More...
 
IDocument Set (string path, OjaiDate value)
 Set OJAI date value in document at given path. More...
 
IDocument Set (string path, OjaiTime value)
 Set OJAI time value in document at given path. More...
 
IDocument Set (string path, OjaiTimestamp value)
 Set OJAI timestamp value in document at given path. More...
 
IDocument Set (string path, OjaiInterval value)
 Set OJAI interval value in document at given path. More...
 
IDocument Set (string path, Byte[] value)
 Set binary value in document at given path. More...
 
IDocument SetList (string path, IList< OjaiValue > value)
 Set IList value in document at given path. More...
 
IDocument SetList (string path, IList< string > value)
 Set IList value in document at given path. More...
 
IDocument SetList (string path, IList< bool > value)
 Set IList value in document at given path. More...
 
IDocument SetList (string path, IList< byte > value)
 Set IList value in document at given path. More...
 
IDocument SetList (string path, IList< short > value)
 Set IList value in document at given path. More...
 
IDocument SetList (string path, IList< int > value)
 Set IList value in document at given path. More...
 
IDocument SetList (string path, IList< long > value)
 Set IList value in document at given path. More...
 
IDocument SetList (string path, IList< float > value)
 Set IList value in document at given path. More...
 
IDocument SetList (string path, IList< double > value)
 Set IList value in document at given path. More...
 
IDocument SetList (string path, IList< decimal > value)
 Set IList value in document at given path. More...
 
IDocument SetList (string path, IList< OjaiDate > value)
 Set IList value in document at given path. More...
 
IDocument SetList (string path, IList< OjaiTime > value)
 Set IList value in document at given path. More...
 
IDocument SetList (string path, IList< OjaiTimestamp > value)
 Set IList value in document at given path. More...
 
IDocument SetList (string path, IList< OjaiInterval > value)
 Set IList value in document at given path. More...
 
IDocument Set (string path, IDictionary< string, OjaiValue > value)
 Set dictionary value in document at given path. More...
 
IDocument Set (string path, IDocument value)
 Set document value in document at given path. More...
 
IDocument Delete (string path)
 Deletes the value at the specified FieldPath if it exists. More...
 
IDocument DeleteID ()
 Deletes the ID field. More...
 
string GetIdString ()
 Returns the String "_id" of this document More...
 
byte [] GetIdBinary ()
 Returns the Binary "_id" of this document More...
 
string GetString (string path)
 Returns the value at the specified fieldPath as a String object or null if the specified FieldPath does not exist in the document. More...
 
bool? GetBool (string path)
 Returns the value at the specified fieldPath as a bool object or null if the specified FieldPath does not exist in the document. More...
 
byte? GetByte (string path)
 Returns the value at the specified fieldPath as a byte object or null if the specified FieldPath does not exist in the document. More...
 
short? GetShort (string path)
 Returns the value at the specified fieldPath as a short object or null if the specified FieldPath does not exist in the document. More...
 
int? GetInt (string path)
 Returns the value at the specified fieldPath as a int object or null if the specified FieldPath does not exist in the document. More...
 
long? GetLong (string path)
 Returns the value at the specified fieldPath as a long object or null if the specified FieldPath does not exist in the document. More...
 
float? GetFloat (string path)
 Returns the value at the specified fieldPath as a float object or null if the specified FieldPath does not exist in the document. More...
 
double? GetDouble (string path)
 Returns the value at the specified fieldPath as a double object or null if the specified FieldPath does not exist in the document. More...
 
decimal? GetDecimal (string path)
 Returns the value at the specified fieldPath as a decimal object or null if the specified FieldPath does not exist in the document. More...
 
OjaiTime GetTime (string path)
 Returns the value at the specified fieldPath as an OjaiTime object or null if the specified FieldPath does not exist in the document. More...
 
OjaiDate GetDate (string path)
 Returns the value at the specified fieldPath as an OjaiDate object or null if the specified FieldPath does not exist in the document. More...
 
OjaiTimestamp GetTimestamp (string path)
 Returns the value at the specified fieldPath as an OjaiTimestamp object or null if the specified FieldPath does not exist in the document. More...
 
byte [] GetBinary (string path)
 Returns the value at the specified fieldPath as a byte[] object or null if the specified FieldPath does not exist in the document. More...
 
OjaiInterval GetInterval (string path)
 Returns the value at the specified fieldPath as an OjaiInterval object or null if the specified FieldPath does not exist in the document. More...
 
OjaiValue GetValue (string path)
 Returns the value at the specified fieldPath as an OjaiValue object or null if the specified FieldPath does not exist in the document. More...
 
IDictionary< string, OjaiValueGetDictionary (string path)
 Returns the value at the specified fieldPath as a Dictionary object or null if the specified FieldPath does not exist in the document. More...
 
IList< OjaiValueGetList (string path)
 Returns the value at the specified fieldPath as a List object or null if the specified FieldPath does not exist in the document. More...
 
IDocument Clear ()
 Clear document. More...
 

Member Function Documentation

◆ Clear()

IDocument MapRDB.Driver.Ojai.IDocument.Clear ( )

Clear document.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ Delete()

IDocument MapRDB.Driver.Ojai.IDocument.Delete ( string  path)

Deletes the value at the specified FieldPath if it exists.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ DeleteID()

IDocument MapRDB.Driver.Ojai.IDocument.DeleteID ( )

Deletes the ID field.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ GetBinary()

byte [] MapRDB.Driver.Ojai.IDocument.GetBinary ( string  path)

Returns the value at the specified fieldPath as a byte[] object or null if the specified FieldPath does not exist in the document.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ GetBool()

bool? MapRDB.Driver.Ojai.IDocument.GetBool ( string  path)

Returns the value at the specified fieldPath as a bool object or null if the specified FieldPath does not exist in the document.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ GetByte()

byte? MapRDB.Driver.Ojai.IDocument.GetByte ( string  path)

Returns the value at the specified fieldPath as a byte object or null if the specified FieldPath does not exist in the document.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ GetDate()

OjaiDate MapRDB.Driver.Ojai.IDocument.GetDate ( string  path)

Returns the value at the specified fieldPath as an OjaiDate object or null if the specified FieldPath does not exist in the document.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ GetDecimal()

decimal? MapRDB.Driver.Ojai.IDocument.GetDecimal ( string  path)

Returns the value at the specified fieldPath as a decimal object or null if the specified FieldPath does not exist in the document.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ GetDictionary()

IDictionary<string, OjaiValue> MapRDB.Driver.Ojai.IDocument.GetDictionary ( string  path)

Returns the value at the specified fieldPath as a Dictionary object or null if the specified FieldPath does not exist in the document.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ GetDouble()

double? MapRDB.Driver.Ojai.IDocument.GetDouble ( string  path)

Returns the value at the specified fieldPath as a double object or null if the specified FieldPath does not exist in the document.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ GetFloat()

float? MapRDB.Driver.Ojai.IDocument.GetFloat ( string  path)

Returns the value at the specified fieldPath as a float object or null if the specified FieldPath does not exist in the document.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ GetIdBinary()

byte [] MapRDB.Driver.Ojai.IDocument.GetIdBinary ( )

Returns the Binary "_id" of this document

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ GetIdString()

string MapRDB.Driver.Ojai.IDocument.GetIdString ( )

Returns the String "_id" of this document

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ GetInt()

int? MapRDB.Driver.Ojai.IDocument.GetInt ( string  path)

Returns the value at the specified fieldPath as a int object or null if the specified FieldPath does not exist in the document.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ GetInterval()

OjaiInterval MapRDB.Driver.Ojai.IDocument.GetInterval ( string  path)

Returns the value at the specified fieldPath as an OjaiInterval object or null if the specified FieldPath does not exist in the document.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ GetList()

IList<OjaiValue> MapRDB.Driver.Ojai.IDocument.GetList ( string  path)

Returns the value at the specified fieldPath as a List object or null if the specified FieldPath does not exist in the document.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ GetLong()

long? MapRDB.Driver.Ojai.IDocument.GetLong ( string  path)

Returns the value at the specified fieldPath as a long object or null if the specified FieldPath does not exist in the document.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ GetShort()

short? MapRDB.Driver.Ojai.IDocument.GetShort ( string  path)

Returns the value at the specified fieldPath as a short object or null if the specified FieldPath does not exist in the document.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ GetString()

string MapRDB.Driver.Ojai.IDocument.GetString ( string  path)

Returns the value at the specified fieldPath as a String object or null if the specified FieldPath does not exist in the document.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ GetTime()

OjaiTime MapRDB.Driver.Ojai.IDocument.GetTime ( string  path)

Returns the value at the specified fieldPath as an OjaiTime object or null if the specified FieldPath does not exist in the document.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ GetTimestamp()

OjaiTimestamp MapRDB.Driver.Ojai.IDocument.GetTimestamp ( string  path)

Returns the value at the specified fieldPath as an OjaiTimestamp object or null if the specified FieldPath does not exist in the document.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ GetValue()

OjaiValue MapRDB.Driver.Ojai.IDocument.GetValue ( string  path)

Returns the value at the specified fieldPath as an OjaiValue object or null if the specified FieldPath does not exist in the document.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ Set() [1/16]

IDocument MapRDB.Driver.Ojai.IDocument.Set ( string  path,
string  value 
)

Set string value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ Set() [2/16]

IDocument MapRDB.Driver.Ojai.IDocument.Set ( string  path,
bool  value 
)

Set bool value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ Set() [3/16]

IDocument MapRDB.Driver.Ojai.IDocument.Set ( string  path,
byte  value 
)

Set byte value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ Set() [4/16]

IDocument MapRDB.Driver.Ojai.IDocument.Set ( string  path,
short  value 
)

Set short value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ Set() [5/16]

IDocument MapRDB.Driver.Ojai.IDocument.Set ( string  path,
int  value 
)

Set int value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ Set() [6/16]

IDocument MapRDB.Driver.Ojai.IDocument.Set ( string  path,
long  value 
)

Set long value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ Set() [7/16]

IDocument MapRDB.Driver.Ojai.IDocument.Set ( string  path,
float  value 
)

Set float value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ Set() [8/16]

IDocument MapRDB.Driver.Ojai.IDocument.Set ( string  path,
double  value 
)

Set double value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ Set() [9/16]

IDocument MapRDB.Driver.Ojai.IDocument.Set ( string  path,
decimal  value 
)

Set decimal value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ Set() [10/16]

IDocument MapRDB.Driver.Ojai.IDocument.Set ( string  path,
OjaiDate  value 
)

Set OJAI date value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ Set() [11/16]

IDocument MapRDB.Driver.Ojai.IDocument.Set ( string  path,
OjaiTime  value 
)

Set OJAI time value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ Set() [12/16]

IDocument MapRDB.Driver.Ojai.IDocument.Set ( string  path,
OjaiTimestamp  value 
)

Set OJAI timestamp value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ Set() [13/16]

IDocument MapRDB.Driver.Ojai.IDocument.Set ( string  path,
OjaiInterval  value 
)

Set OJAI interval value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ Set() [14/16]

IDocument MapRDB.Driver.Ojai.IDocument.Set ( string  path,
Byte []  value 
)

Set binary value in document at given path.

◆ Set() [15/16]

IDocument MapRDB.Driver.Ojai.IDocument.Set ( string  path,
IDictionary< string, OjaiValue value 
)

Set dictionary value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ Set() [16/16]

IDocument MapRDB.Driver.Ojai.IDocument.Set ( string  path,
IDocument  value 
)

Set document value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ SetID() [1/2]

IDocument MapRDB.Driver.Ojai.IDocument.SetID ( string  value)

Set string ID of document.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ SetID() [2/2]

IDocument MapRDB.Driver.Ojai.IDocument.SetID ( byte []  value)

Set binary ID of document.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ SetList() [1/14]

IDocument MapRDB.Driver.Ojai.IDocument.SetList ( string  path,
IList< OjaiValue value 
)

Set IList value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ SetList() [2/14]

IDocument MapRDB.Driver.Ojai.IDocument.SetList ( string  path,
IList< string >  value 
)

Set IList value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ SetList() [3/14]

IDocument MapRDB.Driver.Ojai.IDocument.SetList ( string  path,
IList< bool >  value 
)

Set IList value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ SetList() [4/14]

IDocument MapRDB.Driver.Ojai.IDocument.SetList ( string  path,
IList< byte >  value 
)

Set IList value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ SetList() [5/14]

IDocument MapRDB.Driver.Ojai.IDocument.SetList ( string  path,
IList< short >  value 
)

Set IList value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ SetList() [6/14]

IDocument MapRDB.Driver.Ojai.IDocument.SetList ( string  path,
IList< int >  value 
)

Set IList value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ SetList() [7/14]

IDocument MapRDB.Driver.Ojai.IDocument.SetList ( string  path,
IList< long >  value 
)

Set IList value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ SetList() [8/14]

IDocument MapRDB.Driver.Ojai.IDocument.SetList ( string  path,
IList< float >  value 
)

Set IList value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ SetList() [9/14]

IDocument MapRDB.Driver.Ojai.IDocument.SetList ( string  path,
IList< double >  value 
)

Set IList value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ SetList() [10/14]

IDocument MapRDB.Driver.Ojai.IDocument.SetList ( string  path,
IList< decimal >  value 
)

Set IList value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ SetList() [11/14]

IDocument MapRDB.Driver.Ojai.IDocument.SetList ( string  path,
IList< OjaiDate value 
)

Set IList value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ SetList() [12/14]

IDocument MapRDB.Driver.Ojai.IDocument.SetList ( string  path,
IList< OjaiTime value 
)

Set IList value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ SetList() [13/14]

IDocument MapRDB.Driver.Ojai.IDocument.SetList ( string  path,
IList< OjaiTimestamp value 
)

Set IList value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ SetList() [14/14]

IDocument MapRDB.Driver.Ojai.IDocument.SetList ( string  path,
IList< OjaiInterval value 
)

Set IList value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ SetNull()

IDocument MapRDB.Driver.Ojai.IDocument.SetNull ( string  path)

Set null value in document at given path.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ ToDictionary()

IDictionary<string, OjaiValue> MapRDB.Driver.Ojai.IDocument.ToDictionary ( )

Return document as dictionary.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ ToJsonString() [1/2]

string MapRDB.Driver.Ojai.IDocument.ToJsonString ( )

Parse document into JSON string.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.

◆ ToJsonString() [2/2]

string MapRDB.Driver.Ojai.IDocument.ToJsonString ( Formatting  formatting)

Parse document into JSON string.

Implemented in MapRDB.Driver.Ojai.OjaiDocument.