RowsetBase MembersNFX Class Library

[This is preliminary documentation and is subject to change.]

The RowsetBase type exposes the following members.
Constructors

  NameDescription
Protected methodRowsetBase
Creates an empty rowset
Back to Top
Methods

  NameDescription
Public methodAdd
Inserts a row
Protected methodCheck
Checks argument for being non-null and of the same schema with this rowset
Public methodClear
Purges table
Public methodCompare
Compares two rows
Public methodContains
Public methodCopyTo
Public methodDelete( Object )
Tries to find a row with the same set of key fields in this table and if found, deletes it and returns its index, otherwise -1
Public methodDelete(Row, IDataStoreKey)
Tries to find a row with the same set of key fields in this table and if found, deletes it and returns its index, otherwise -1
Public methodDeleteAll
Deletes all rows from table. This method is similar to Purge() but does logging (when enabled)
Protected methodDoDelete
Tries to find a row with the same set of key fields in this table and if found, deletes it and returns its index, otherwise -1
Protected methodDoInsert
Tries to insert a row. If another row with the same set of key fields already in the table returns -1, otherwise returns insertion index
Protected methodDoUpdate
Tries to find a row with the same set of key fields in this table and if found, replaces it and returns its index, otherwise returns -1
Protected methodDoUpsert
Tries to find a row with the same set of key fields in this table and if found, replaces it and returns true, otherwise inserts the row (if schemas match) and returns false. Optionally pass updateWhere condition that may check whether update needs to be performed
Public methodOnlineEquals
Determines whether the specified object is equal to the current object.
(Inherited from OnlineObject.)
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodFindByKey( Object )
Tries to find a row by specified keyset and returns it or null if not found. This method does not perform well on Rowsets instances as a rowset is unordered list which does linear search. In contrast, Tables are always ordered and perform binary search instead
Public methodFindByKey(Row)
Tries to find a row by specified keyset and returns it or null if not found
Public methodFindByKey(Row, Func Row, Boolean )
Tries to find a row by specified keyset and extra WHERE clause and returns it or null if not found. This method does not perform well on Rowsets instances as a rowset is unordered list which does linear search. In contrast, Tables are always ordered and perform binary search instead
Public methodFindByKey(Func Row, Boolean ,  Object )
Tries to find a row by specified keyset and extra WHERE clause and returns it or null if not found
Public methodStatic memberFromJSON(String, Boolean, Boolean)
Reads either Table or Rowset from JSON created by WriteAsJSON. Metadata must be present
Public methodStatic memberFromJSON(JSONDataMap, Boolean, Boolean)
Reads either Table or Rowset from JSON created by WriteAsJSON. Metadata must be present
Public methodStatic memberFromJSON(JSONDataMap, Boolean , Boolean, Boolean, SetFieldFunc)
Reads either Table or Rowset from JSON created by WriteAsJSON. Metadata must be present. allMatched==false when some data did not match schema (i.e. too little fields or extra fields supplied)
Public methodStatic memberFromJSON T (String, RowsetBase , SetFieldFunc)
Reads either Table or Rowset from JSON created by WriteAsJSON.
Public methodStatic memberFromJSON T (JSONDataMap, RowsetBase , SetFieldFunc)
Reads either Table or Rowset from JSON created by WriteAsJSON.
Public methodGetChangeAt
Retrievs a change by index or null if index is out of bounds or changes are not logged
Public methodGetEnumerator
Public methodOnlineGetHashCode
Serves as the default hash function.
(Inherited from OnlineObject.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodIndexOf
Public methodInsert(Row)
Inserts the row. Returns insertion index
Public methodInsert(Int32, Row)
Inserts row at index
Public methodKeyRowFromValues
Creates key row out of field values for keys
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodPurge
Deletes all rows from table without logging the deleted modifications even when LogModifications=true
Public methodPurgeChanges
Clears modifications accumulated by this instance
Public methodRemove
Performs row delete
Public methodRemoveAt
Deletes row
Protected methodSearchForRow
Provides rowsearching. Override to do binary search in sorted rowsets
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Public methodUpdate
Updates the row, Returns the row index or -1
Public methodUpsert
Tries to find a row for update and if found, updates it and returns true, otherwise inserts the row (if schemas match) and returns false. Optionally pass updateWhere condition that may check whether update needs to be performed
Public methodValidate
Validates all rows in this rowset. Override to perform custom validations. The method is not expected to throw exception in case of failed validation, rather return exception instance because throwing exception really hampers validation performance when many rows need to be validated
Public methodWriteAsJSON
Writes rowset as JSON including schema information. Do not call this method directly, instead call rowset.ToJSON() or use JSONWriter class
Back to Top
Extension Methods

  NameDescription
Public Extension MethodAsBool (Defined by ObjectValueConversion.)
Public Extension MethodAsByte (Defined by ObjectValueConversion.)
Public Extension MethodAsChar (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime(DateTime, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsEnumerableOf TRow 
Casts enumerable of rows (such as rowset) to the specified row type, returning empty enumerable if the source is null
(Defined by DataUtils.)
Public Extension MethodAsFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID(GDID, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsInt (Defined by ObjectValueConversion.)
Public Extension MethodAsJSONConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLaconicConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLong (Defined by ObjectValueConversion.)
Public Extension MethodAsLookAheadEnumerable Row  (Defined by LookAheadExtensions.)
Public Extension MethodAsNonNullOrEmptyString (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableBool (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableChar (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDateTime (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDIDSymbol (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableShort (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableTimeSpan (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableULong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsShort (Defined by ObjectValueConversion.)
Public Extension MethodAsString (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan(TimeSpan, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsULong (Defined by ObjectValueConversion.)
Public Extension MethodAsUri (Defined by ObjectValueConversion.)
Public Extension MethodAsUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsXMLConfig (Defined by ObjectValueConversion.)
Public Extension MethodDistinct Row, TKey  (Defined by CollectionUtils.)
Public Extension MethodFirstMax Row, TComparand (Func Row, TComparand )Overloaded. (Defined by CollectionUtils.)
Public Extension MethodFirstMax Row, TComparand (Func Row, TComparand , TComparand )Overloaded. (Defined by CollectionUtils.)
Public Extension MethodFirstMin Row, TComparand (Func Row, TComparand )Overloaded. (Defined by CollectionUtils.)
Public Extension MethodFirstMin Row, TComparand (Func Row, TComparand , TComparand )Overloaded. (Defined by CollectionUtils.)
Public Extension MethodFirstOrAnyOrDefault Row 
Tries to find the first element that matches the predicate and returns it, otherwise returns the first element found or default (i.e. null)
(Defined by CollectionUtils.)
Public Extension MethodForEach Row (Action Row )Overloaded.
Runs some method over each element of src sequence
(Defined by CollectionUtils.)
Public Extension MethodForEach Row (Action Row, Int32 )Overloaded.
Runs some method over each element of src sequence
(Defined by CollectionUtils.)
Public Extension MethodSkipLast Row  Overloaded.
Takes all elements except for last element from the given source
(Defined by CollectionUtils.)
Public Extension MethodSkipLast Row (Int32)Overloaded.
Takes all but last N elements from the source
(Defined by CollectionUtils.)
Public Extension MethodToErlObject Overloaded.
Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToErlObject(ErlTypeOrder, Boolean)Overloaded.
Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToJSON(JSONWritingOptions)Overloaded.
Serializes object into JSON string
(Defined by JSONExtensions.)
Public Extension MethodToJSON(TextWriter, JSONWritingOptions)Overloaded.
Serializes object into JSON format using provided TextWriter
(Defined by JSONExtensions.)
Public Extension MethodToJSON(Stream, JSONWritingOptions, Encoding)Overloaded.
Serializes object into JSON format using provided stream and optional encoding
(Defined by JSONExtensions.)
Back to Top
Fields

  NameDescription
Protected fieldm_Changes
Protected fieldm_List
Protected fieldm_Schema
Back to Top
Properties

  NameDescription
Public propertyAsReadonlyIList
Returns data as non-generic readonly IList
Public propertyChangeCount
Returns a count of accumulated modifications performed on the rowset, or zero when no modifications have been made or LogModifications = false
Public propertyChanges
Returns accumulated modifications performed on the rowset, or empty enumerator if no modifications have been made or LogModifications = false
Public propertyContext
Provides dynamic view of rowset's data context - attributes applicable to the whole rowset
Public propertyContextMap
Provides dynamic view as JSONDataMap of rowset's data context - attributes applicable to the whole rowset
Public propertyCount
Returns row count in this rowset
Public propertyInstanceGUID
Returns globaly-unique instance ID. This ID is useful as a key for storing rowsets in object stores and posting data back from web client to server.
Public propertyIsReadOnly
Public propertyItem
This method performs update on set
Public propertyLogChanges
Gets/Sets whether this rowset keeps track of all modifications done to it. This property must be set to true to be able to save changes into ICRUDDataStore
Public propertySchema
Returns a schema for rows that this rowset contains
Back to Top
Explicit Interface Implementations

  NameDescription
Explicit interface implemetationPrivate methodIEnumerable GetEnumerator
Back to Top
See Also