Rowset MembersNFX Class Library

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

The Rowset type exposes the following members.
Constructors

  NameDescription
Public methodRowset(Schema)
Creates an empty rowset
Public methodRowset(RowsetBase, Func Row, Boolean )
Creates a shallow copy from another rowset, optionally applying a filter
Back to Top
Methods

  NameDescription
Public methodAdd
Inserts a row
(Inherited from RowsetBase.)
Protected methodCheck
Checks argument for being non-null and of the same schema with this rowset
(Inherited from RowsetBase.)
Public methodClear
Purges table
(Inherited from RowsetBase.)
Public methodCompare (Overrides RowsetBase Compare(Row, Row).)
Public methodContains (Inherited from RowsetBase.)
Public methodCopyTo (Inherited from RowsetBase.)
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
(Inherited from RowsetBase.)
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
(Inherited from RowsetBase.)
Public methodDeleteAll
Deletes all rows from table. This method is similar to Purge() but does logging (when enabled)
(Inherited from RowsetBase.)
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
(Inherited from RowsetBase.)
Protected methodDoInsert (Overrides RowsetBase DoInsert(Row).)
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
(Inherited from RowsetBase.)
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
(Inherited from RowsetBase.)
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
(Inherited from RowsetBase.)
Public methodFindByKey(Row)
Tries to find a row by specified keyset and returns it or null if not found
(Inherited from RowsetBase.)
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
(Inherited from RowsetBase.)
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
(Inherited from RowsetBase.)
Public methodGetChangeAt
Retrievs a change by index or null if index is out of bounds or changes are not logged
(Inherited from RowsetBase.)
Public methodGetEnumerator (Inherited from RowsetBase.)
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 (Inherited from RowsetBase.)
Public methodInsert(Row)
Inserts the row. Returns insertion index
(Inherited from RowsetBase.)
Public methodInsert(Int32, Row)
Inserts row at index
(Inherited from RowsetBase.)
Public methodKeyRowFromValues
Creates key row out of field values for keys
(Inherited from RowsetBase.)
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
(Inherited from RowsetBase.)
Public methodPurgeChanges
Clears modifications accumulated by this instance
(Inherited from RowsetBase.)
Public methodRemove
Performs row delete
(Inherited from RowsetBase.)
Public methodRemoveAt
Deletes row
(Inherited from RowsetBase.)
Protected methodSearchForRow
Provides rowsearching. Override to do binary search in sorted rowsets
(Inherited from RowsetBase.)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Public methodUpdate
Updates the row, Returns the row index or -1
(Inherited from RowsetBase.)
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
(Inherited from RowsetBase.)
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
(Inherited from RowsetBase.)
Public methodWriteAsJSON
Writes rowset as JSON including schema information. Do not call this method directly, instead call rowset.ToJSON() or use JSONWriter class
(Inherited from RowsetBase.)
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 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 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 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 (Inherited from RowsetBase.)
Protected fieldm_List (Inherited from RowsetBase.)
Protected fieldm_Schema (Inherited from RowsetBase.)
Protected fieldm_SortFieldList
Back to Top
Properties

  NameDescription
Public propertyAsReadonlyIList
Returns data as non-generic readonly IList
(Inherited from RowsetBase.)
Public propertyChangeCount
Returns a count of accumulated modifications performed on the rowset, or zero when no modifications have been made or LogModifications = false
(Inherited from RowsetBase.)
Public propertyChanges
Returns accumulated modifications performed on the rowset, or empty enumerator if no modifications have been made or LogModifications = false
(Inherited from RowsetBase.)
Public propertyContext
Provides dynamic view of rowset's data context - attributes applicable to the whole rowset
(Inherited from RowsetBase.)
Public propertyContextMap
Provides dynamic view as JSONDataMap of rowset's data context - attributes applicable to the whole rowset
(Inherited from RowsetBase.)
Public propertyCount
Returns row count in this rowset
(Inherited from RowsetBase.)
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.
(Inherited from RowsetBase.)
Public propertyIsReadOnly (Inherited from RowsetBase.)
Public propertyItem
This method performs update on set
(Inherited from RowsetBase.)
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
(Inherited from RowsetBase.)
Public propertySchema
Returns a schema for rows that this rowset contains
(Inherited from RowsetBase.)
Public propertySortDefinition
Sort definition is a comma-separated field name list where every field may optionally be prefixed with `+` for ascending or `-` for descending sort order specifier. Example: "FirstName,-DOB"
Back to Top
Explicit Interface Implementations

  NameDescription
Explicit interface implemetationPrivate methodIEnumerable GetEnumerator (Inherited from RowsetBase.)
Back to Top
See Also