/ doc / toc / ARCCore / Class / PropertyStreamLine

PropertyStreamLine

Edit keys at this level only

Edit keys at all sub levels.
NOTE: Edits are always additive. Use 'Invalid' in order to delete keys.

__TOCDet/Assembly = ARCCore
__TOCDet/Description = Has two main functions:0x000D0x000A0x000D0x000A1) Encodes and decodes single lines in the -PropertyStream-.0x000D0x000ASee methods like -EncodeKeyPart-, -EncodeValuePart- and -Decode-.0x000D0x000A0x000D0x000A2) Stores single lines in the -PropertyStream- into a data-storage. See -TryStore-.0x000D0x000A0x000D0x000A3) Parses a collection of -PropertyStream- lines into a single -IP- instanse.0x000D0x000ASee methods like -TryParseDirectToIP-.0x000D0x000A0x000D0x000A4) Parses a single -PropertyStream- line into a single property.0x000D0x000ASee methods like -TryParseDirectToProperty-.0x000D0x000A0x000D0x000AA line consists of a key-part, the separator ' = ' (space, equals sign, space) and a value part.0x000D0x000A(the value part may be empty, see -PValueEmpty-).0x000D0x000A0x000D0x000AExamples are (syntax only approximate as of May 2020):0x000D0x000A'// This is a comment (lines starting with // are to be ignored in any processing0x000D0x000A'dt/Customer/42 (create new Customer object, actually this line is not necessary)0x000D0x000A'dt/Customer/42/Cid = User/43' (See -Cid-)0x000D0x000A'dt/Customer/42/FirstName = John'0x000D0x000A'dt/Customer/42/PhoneNumber/+4790534333' (create new PhoneNumber)0x000D0x000A'dt/Customer/42/PhoneNumber/+4790534333/Invalid' (Equivalent to 'delete', see -Invalid)0x000D0x000A0x000D0x000A'dt/Order/1968/CustomerId = Customer/42'0x000D0x000A0x000D0x000A'dt/OrderLine/2001/OrderId = 1968'0x000D0x000A'dt/OrderLine/2001/ProductId = 2003'0x000D0x000A'dt/OrderLine/2001/Quantity = 3'0x000D0x000A0x000D0x000A'dt/Product/2003/Name = Widget3'0x000D0x000A'dt/Product/2003/Colour = Red'0x000D0x000A0x000D0x000ANote that timestamps are normally not needed because the property stream is sequentially organised, and timestamps are inserted automatically (see -TimestampResolution-).0x000D0x000ASee -EncodeKeyPart- and -EncodeValuePart- for how data is actually encoded (examples given above are only indicative).0x000D0x000A0x000D0x000ANote that this class is static, that is, no instances if this class are ever created.0x000D0x000AInstead simple strings are used for representing property stream lines for transmission and storage. This is considered to be more efficient (less processing required) and take up less memory (especially for -CoreDB-).
__TOCDet/DocFragType = Class
__TOCDet/LongDescription = FAQ: Is the property stream (and AgoRapide in general) strongly or weakly typed?0x000D0x000AThat is up to you.0x000D0x000AFor getting started, and just in order to experiment with some various data, you can start weakly typed, or just use strings everywhere.0x000D0x000AA standard storage like -PRich- and a generic -ARAAPI- built on top of that is not dependent on any pre-defined structure, it just accepts whatever is in the property stream.0x000D0x000AIn your C# code you can use multi-level indexing like this: 'DataStorage0x005B"Customer"0x005D0x005B"42"0x005D0x005B"FirstName"0x005D = "John"' without bothering about types at all (or just send the corresponding -PropertyStreamLine- 'dt/Customer/42/FirstName = John' to -TryParse-).0x000D0x000AAs your project matures and you see which classes and properties are more important, you can create the corresponding 'entity' classes and their -PropertyKeyEnum-, and specify more exact types for the properties.0x000D0x000ATaken into account concepts like -LinkInsertionInDocumentation- this will also constitute documenting your application.0x000D0x000ANote that though you can choose the level of dynamic typing (as shown), static strong typing is always a bit weaker with -PropertyAccess-. See -AssertTypeIntegrity- and -BoilerplateCodeProperties- for attempts at alleviating this.0x000D0x000A0x000D0x000AFAQ: How does the property stream format compare to the JSON format?0x000D0x000AThe short answer is that JSON is well suited when you want to transfer a whole object.0x000D0x000AIf you want to transfer parts of an object, for instance updating one single property, then the property stream format is better suited.0x000D0x000AA JSON representation of some given data points could be seen as a 'compiled' variant of the same data points stored as property stream lines.0x000D0x000AThis is because the original property stream lines for a given JSON representation may be spread out (not being located close to each other).0x000D0x000ANote however that if the actual property stream lines (for some given data points) reside consequently to each other in the data storage, then JSON would be a much more effective format for representation because it is much less verbose.0x000D0x000ATODO: Insert examples here in order to clarify.0x000D0x000A0x000D0x000ASome notes about compression:0x000D0x000ANote how the format used is somewhat verbose but well suited for on-disk compression.0x000D0x000AIt is for instance inefficient (storage-wise) to repeat the same context line after line.0x000D0x000ABut on the other hand, the underlying OS can easily be instructed to compress the storage files instead (something it should be able to do quite efficiently, leaving the size-issue to mostly constitute a network bandwidth problem.0x000D0x000ANote that some optimizations are performed anyway, see for instance -Timestamp- which describes how timestamps are not added to each and every property stream line but inserted as needed.0x000D0x000A0x000D0x000A
__TOCDet/Name = PropertyStreamLine
__TOCDet/Namespace = ARCCore
__TOCDet/Type = PropertyStreamLine
__TOCDet/Attribute/AssemblyName = ARCCore
__TOCDet/Attribute/ClassNamespace = ARCCore
__TOCDet/Attribute/ClassType = PropertyStreamLine
__TOCDet/Attribute/Description = Has two main functions:0x000D0x000A0x000D0x000A1) Encodes and decodes single lines in the -PropertyStream-.0x000D0x000ASee methods like -EncodeKeyPart-, -EncodeValuePart- and -Decode-.0x000D0x000A0x000D0x000A2) Stores single lines in the -PropertyStream- into a data-storage. See -TryStore-.0x000D0x000A0x000D0x000A3) Parses a collection of -PropertyStream- lines into a single -IP- instanse.0x000D0x000ASee methods like -TryParseDirectToIP-.0x000D0x000A0x000D0x000A4) Parses a single -PropertyStream- line into a single property.0x000D0x000ASee methods like -TryParseDirectToProperty-.0x000D0x000A0x000D0x000AA line consists of a key-part, the separator ' = ' (space, equals sign, space) and a value part.0x000D0x000A(the value part may be empty, see -PValueEmpty-).0x000D0x000A0x000D0x000AExamples are (syntax only approximate as of May 2020):0x000D0x000A'// This is a comment (lines starting with // are to be ignored in any processing0x000D0x000A'dt/Customer/42 (create new Customer object, actually this line is not necessary)0x000D0x000A'dt/Customer/42/Cid = User/43' (See -Cid-)0x000D0x000A'dt/Customer/42/FirstName = John'0x000D0x000A'dt/Customer/42/PhoneNumber/+4790534333' (create new PhoneNumber)0x000D0x000A'dt/Customer/42/PhoneNumber/+4790534333/Invalid' (Equivalent to 'delete', see -Invalid)0x000D0x000A0x000D0x000A'dt/Order/1968/CustomerId = Customer/42'0x000D0x000A0x000D0x000A'dt/OrderLine/2001/OrderId = 1968'0x000D0x000A'dt/OrderLine/2001/ProductId = 2003'0x000D0x000A'dt/OrderLine/2001/Quantity = 3'0x000D0x000A0x000D0x000A'dt/Product/2003/Name = Widget3'0x000D0x000A'dt/Product/2003/Colour = Red'0x000D0x000A0x000D0x000ANote that timestamps are normally not needed because the property stream is sequentially organised, and timestamps are inserted automatically (see -TimestampResolution-).0x000D0x000ASee -EncodeKeyPart- and -EncodeValuePart- for how data is actually encoded (examples given above are only indicative).0x000D0x000A0x000D0x000ANote that this class is static, that is, no instances if this class are ever created.0x000D0x000AInstead simple strings are used for representing property stream lines for transmission and storage. This is considered to be more efficient (less processing required) and take up less memory (especially for -CoreDB-).
__TOCDet/Attribute/LongDescription = FAQ: Is the property stream (and AgoRapide in general) strongly or weakly typed?0x000D0x000AThat is up to you.0x000D0x000AFor getting started, and just in order to experiment with some various data, you can start weakly typed, or just use strings everywhere.0x000D0x000AA standard storage like -PRich- and a generic -ARAAPI- built on top of that is not dependent on any pre-defined structure, it just accepts whatever is in the property stream.0x000D0x000AIn your C# code you can use multi-level indexing like this: 'DataStorage0x005B"Customer"0x005D0x005B"42"0x005D0x005B"FirstName"0x005D = "John"' without bothering about types at all (or just send the corresponding -PropertyStreamLine- 'dt/Customer/42/FirstName = John' to -TryParse-).0x000D0x000AAs your project matures and you see which classes and properties are more important, you can create the corresponding 'entity' classes and their -PropertyKeyEnum-, and specify more exact types for the properties.0x000D0x000ATaken into account concepts like -LinkInsertionInDocumentation- this will also constitute documenting your application.0x000D0x000ANote that though you can choose the level of dynamic typing (as shown), static strong typing is always a bit weaker with -PropertyAccess-. See -AssertTypeIntegrity- and -BoilerplateCodeProperties- for attempts at alleviating this.0x000D0x000A0x000D0x000AFAQ: How does the property stream format compare to the JSON format?0x000D0x000AThe short answer is that JSON is well suited when you want to transfer a whole object.0x000D0x000AIf you want to transfer parts of an object, for instance updating one single property, then the property stream format is better suited.0x000D0x000AA JSON representation of some given data points could be seen as a 'compiled' variant of the same data points stored as property stream lines.0x000D0x000AThis is because the original property stream lines for a given JSON representation may be spread out (not being located close to each other).0x000D0x000ANote however that if the actual property stream lines (for some given data points) reside consequently to each other in the data storage, then JSON would be a much more effective format for representation because it is much less verbose.0x000D0x000ATODO: Insert examples here in order to clarify.0x000D0x000A0x000D0x000ASome notes about compression:0x000D0x000ANote how the format used is somewhat verbose but well suited for on-disk compression.0x000D0x000AIt is for instance inefficient (storage-wise) to repeat the same context line after line.0x000D0x000ABut on the other hand, the underlying OS can easily be instructed to compress the storage files instead (something it should be able to do quite efficiently, leaving the size-issue to mostly constitute a network bandwidth problem.0x000D0x000ANote that some optimizations are performed anyway, see for instance -Timestamp- which describes how timestamps are not added to each and every property stream line but inserted as needed.0x000D0x000A0x000D0x000A
AllowedKeyChars/__TOCDet/Assembly = ARCCore
AllowedKeyChars/__TOCDet/Description = Allowed characters in the Key-part of a -PropertyStreamLine-.0x000D0x000A0x000D0x000AThe character set 'A...Za...z0...9-_().,' from -AllowedEncodedCharacters- plus ' ' (space), '"' (double quote), ''' (single quote) and '|§!#%&=?+^¨~'.0x000D0x000A0x000D0x000AASCII characters important to avoid are:0x000D0x000A'/' (slash) (because used as a separator in the 'key' part of a property stream line,0x000D0x000A'0x003B' (semicolon) because used as separator for a collection of values (see -WholeCollection-).0x000D0x000Aand all control characters (especially CR and LF, ASCII 13 and 10).0x000D0x000A0x000D0x000ANOTE: The selection of characters are somewhat hastily chosen (as of May 2020) and may change in the future.0x000D0x000A0x000D0x000ASee also -AllowedValueChars-.0x000D0x000A
AllowedKeyChars/__TOCDet/DocFragType = ClassMember
AllowedKeyChars/__TOCDet/IsInherited = False
AllowedKeyChars/__TOCDet/IsInheritedDoc = False
AllowedKeyChars/__TOCDet/Lines = 13
AllowedKeyChars/__TOCDet/Name = AllowedKeyChars
AllowedKeyChars/__TOCDet/Namespace = ARCCore
AllowedKeyChars/__TOCDet/Type = PropertyStreamLine
AllowedKeyChars/__TOCDet/Attribute/DeclaringType = PropertyStreamLine
AllowedKeyChars/__TOCDet/Attribute/Description = Allowed characters in the Key-part of a -PropertyStreamLine-.0x000D0x000A0x000D0x000AThe character set 'A...Za...z0...9-_().,' from -AllowedEncodedCharacters- plus ' ' (space), '"' (double quote), ''' (single quote) and '|§!#%&=?+^¨~'.0x000D0x000A0x000D0x000AASCII characters important to avoid are:0x000D0x000A'/' (slash) (because used as a separator in the 'key' part of a property stream line,0x000D0x000A'0x003B' (semicolon) because used as separator for a collection of values (see -WholeCollection-).0x000D0x000Aand all control characters (especially CR and LF, ASCII 13 and 10).0x000D0x000A0x000D0x000ANOTE: The selection of characters are somewhat hastily chosen (as of May 2020) and may change in the future.0x000D0x000A0x000D0x000ASee also -AllowedValueChars-.0x000D0x000A
AllowedKeyChars/__TOCDet/Attribute/MethodName = AllowedKeyChars
AllowedKeyChars/__TOCDet/Attribute/MethodSignature = System.Collections.Generic.HashSet0x006010x005BSystem.Char0x005D AllowedKeyChars
AllowedValueChars/__TOCDet/Assembly = ARCCore
AllowedValueChars/__TOCDet/Description = Allowed characters in the Value-part of a -PropertyStreamLine-.0x000D0x000A0x000D0x000AThe character set -AllowedKeyChars- plus '=' (equals), '/' (forward slash), '*' (asterisk) and '' (backslash).0x000D0x000A(note that in general the value part is not as critical regarding encoding because 'everything' after the key, value separator ' = ' is the actual value.)0x000D0x000A0x000D0x000ATODO: Change into 'DisallowedASCIIChars' instead of allowed chars.0x000D0x000ATODO: See -EncodeValuePart- for more information.0x000D0x000A0x000D0x000AASCII characters important to avoid are:0x000D0x000A'0x003B' (semicolon) because used as separator for a collection of values (see -WholeCollection-).0x000D0x000A
AllowedValueChars/__TOCDet/DocFragType = ClassMember
AllowedValueChars/__TOCDet/IsInherited = False
AllowedValueChars/__TOCDet/IsInheritedDoc = False
AllowedValueChars/__TOCDet/Lines = 11
AllowedValueChars/__TOCDet/Name = AllowedValueChars
AllowedValueChars/__TOCDet/Namespace = ARCCore
AllowedValueChars/__TOCDet/Type = PropertyStreamLine
AllowedValueChars/__TOCDet/Attribute/DeclaringType = PropertyStreamLine
AllowedValueChars/__TOCDet/Attribute/Description = Allowed characters in the Value-part of a -PropertyStreamLine-.0x000D0x000A0x000D0x000AThe character set -AllowedKeyChars- plus '=' (equals), '/' (forward slash), '*' (asterisk) and '' (backslash).0x000D0x000A(note that in general the value part is not as critical regarding encoding because 'everything' after the key, value separator ' = ' is the actual value.)0x000D0x000A0x000D0x000ATODO: Change into 'DisallowedASCIIChars' instead of allowed chars.0x000D0x000ATODO: See -EncodeValuePart- for more information.0x000D0x000A0x000D0x000AASCII characters important to avoid are:0x000D0x000A'0x003B' (semicolon) because used as separator for a collection of values (see -WholeCollection-).0x000D0x000A
AllowedValueChars/__TOCDet/Attribute/MethodName = AllowedValueChars
AllowedValueChars/__TOCDet/Attribute/MethodSignature = System.Collections.Generic.HashSet0x006010x005BSystem.Char0x005D AllowedValueChars
Decode/__TOCDet/Assembly = ARCCore
Decode/__TOCDet/Description = Decodes string as encoded by -EncodeKeyPart- or -EncodeValuePart-.0x000D0x000A0x000D0x000A0x000D0x000ANOTE: Takes up a significant amount of processing time, for instance when called by -TryParse-0x000D0x000A0x000D0x000ATODO: A smarter encoding has great potential for quicker decoding. For instance a prefix in a -PropertyStreamLine-0x000D0x000ATODO: hinting about level of encoding necessary. Like '_' indicating no special encoding for instance.0x000D0x000ATODO: In general AgoRapide application will read the property stream much more frequent than writing to it.0x000D0x000A0x000D0x000ANote how the decoder is common, used for both the key-part and the value-part of the -PropertyStreamLine-.0x000D0x000ANote that when the value-part constitutes of multiple items (-WholeCollection-), it is actually decoded twice, first by -TryParse- for the value-part as a whole, and then again by the parser created by -ModifyCleanerAndValidatorAndParserForCardinality-.0x000D0x000A0x000D0x000ASingle illegal instances of '0xoooo (0xoooo not followed by a valid 4-digit hex number (and not followed by 'oooo'))0x000D0x000Aare returned in-original.0x000D0x000A
Decode/__TOCDet/DocFragType = ClassMember
Decode/__TOCDet/IsInherited = False
Decode/__TOCDet/IsInheritedDoc = False
Decode/__TOCDet/Lines = 15
Decode/__TOCDet/Name = Decode
Decode/__TOCDet/Namespace = ARCCore
Decode/__TOCDet/Type = PropertyStreamLine
Decode/__TOCDet/Attribute/DeclaringType = PropertyStreamLine
Decode/__TOCDet/Attribute/Description = Decodes string as encoded by -EncodeKeyPart- or -EncodeValuePart-.0x000D0x000A0x000D0x000A0x000D0x000ANOTE: Takes up a significant amount of processing time, for instance when called by -TryParse-0x000D0x000A0x000D0x000ATODO: A smarter encoding has great potential for quicker decoding. For instance a prefix in a -PropertyStreamLine-0x000D0x000ATODO: hinting about level of encoding necessary. Like '_' indicating no special encoding for instance.0x000D0x000ATODO: In general AgoRapide application will read the property stream much more frequent than writing to it.0x000D0x000A0x000D0x000ANote how the decoder is common, used for both the key-part and the value-part of the -PropertyStreamLine-.0x000D0x000ANote that when the value-part constitutes of multiple items (-WholeCollection-), it is actually decoded twice, first by -TryParse- for the value-part as a whole, and then again by the parser created by -ModifyCleanerAndValidatorAndParserForCardinality-.0x000D0x000A0x000D0x000ASingle illegal instances of '0xoooo (0xoooo not followed by a valid 4-digit hex number (and not followed by 'oooo'))0x000D0x000Aare returned in-original.0x000D0x000A
Decode/__TOCDet/Attribute/MethodName = Decode
Decode/__TOCDet/Attribute/MethodSignature = System.String Decode(System.String)
EncodeKeyPart/__TOCDet/Assembly = ARCCore
EncodeKeyPart/__TOCDet/Description = Converts a single key part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-. 0x000D0x000AThe resulting format is supposed to be quite human-readable.0x000D0x000A0x000D0x000AReturns a string containing only characters in -AllowedKeyChars-.0x000D0x000AOther characters are represented by '0xoooo' plus their UTF-16 code value as four hex characters (like '0xoooo0020' for space).0x000D0x000A(0xoooo itself is changed into 0xoooooooo before conversion takes place.)0x000D0x000A0x000D0x000AUsually called from functions like -EncodeKeys-.0x000D0x000A0x000D0x000AFor instance for the following0x000D0x000Akey parts: 'Customer', '42', '+4790534333', 'Cid'0x000D0x000Aand value part: 'Actor/43'0x000D0x000Athe correct format is: Customer/42/PhoneNumber/0xoooo002B4790534333/Cid = Actor/430x000D0x000A('Customer/42/PhoneNumber/0xoooo002B4790534333/Cid' is what this function encodes.)0x000D0x000A0x000D0x000ANote: -IKString- used the same type of encoding but with another set of allowed characters.0x000D0x000A0x000D0x000ASee also -Decode- and -EncodeValuePart-.
EncodeKeyPart/__TOCDet/DocFragType = ClassMember
EncodeKeyPart/__TOCDet/IsInherited = False
EncodeKeyPart/__TOCDet/IsInheritedDoc = False
EncodeKeyPart/__TOCDet/Lines = 18
EncodeKeyPart/__TOCDet/Name = EncodeKeyPart
EncodeKeyPart/__TOCDet/Namespace = ARCCore
EncodeKeyPart/__TOCDet/Type = PropertyStreamLine
EncodeKeyPart/__TOCDet/Attribute/DeclaringType = PropertyStreamLine
EncodeKeyPart/__TOCDet/Attribute/Description = Converts a single key part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-. 0x000D0x000AThe resulting format is supposed to be quite human-readable.0x000D0x000A0x000D0x000AReturns a string containing only characters in -AllowedKeyChars-.0x000D0x000AOther characters are represented by '0xoooo' plus their UTF-16 code value as four hex characters (like '0xoooo0020' for space).0x000D0x000A(0xoooo itself is changed into 0xoooooooo before conversion takes place.)0x000D0x000A0x000D0x000AUsually called from functions like -EncodeKeys-.0x000D0x000A0x000D0x000AFor instance for the following0x000D0x000Akey parts: 'Customer', '42', '+4790534333', 'Cid'0x000D0x000Aand value part: 'Actor/43'0x000D0x000Athe correct format is: Customer/42/PhoneNumber/0xoooo002B4790534333/Cid = Actor/430x000D0x000A('Customer/42/PhoneNumber/0xoooo002B4790534333/Cid' is what this function encodes.)0x000D0x000A0x000D0x000ANote: -IKString- used the same type of encoding but with another set of allowed characters.0x000D0x000A0x000D0x000ASee also -Decode- and -EncodeValuePart-.
EncodeKeyPart/__TOCDet/Attribute/MethodName = EncodeKeyPart
EncodeKeyPart/__TOCDet/Attribute/MethodSignature = System.String EncodeKeyPart(System.String)
EncodeKeys/__TOCDet/Assembly = ARCCore
EncodeKeys/__TOCDet/Description = Encodes the key part of a -PropertyStreamLine-.0x000D0x000AExample result: Customer/42/FirstName
EncodeKeys/__TOCDet/DocFragType = ClassMember
EncodeKeys/__TOCDet/IsInherited = False
EncodeKeys/__TOCDet/IsInheritedDoc = False
EncodeKeys/__TOCDet/Lines = 2
EncodeKeys/__TOCDet/Name = EncodeKeys
EncodeKeys/__TOCDet/Namespace = ARCCore
EncodeKeys/__TOCDet/Type = PropertyStreamLine
EncodeKeys/__TOCDet/Attribute/DeclaringType = PropertyStreamLine
EncodeKeys/__TOCDet/Attribute/Description = Encodes the key part of a -PropertyStreamLine-.0x000D0x000AExample result: Customer/42/FirstName
EncodeKeys/__TOCDet/Attribute/MethodName = EncodeKeys
EncodeKeys/__TOCDet/Attribute/MethodSignature = System.String EncodeKeys(System.Collections.Generic.IEnumerable0x006010x005BARCCore.IK0x005D)
EncodeValuePart/__TOCDet/Assembly = ARCCore
EncodeValuePart/__TOCDet/Description = Converts a single value part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-. 0x000D0x000AThe resulting format is supposed to be quite human-readable.0x000D0x000A0x000D0x000AReturns a string containing only characters in -AllowedValueChars-.0x000D0x000AOther characters are represented by '0xoooo' plus their UTF-16 code value as four hex characters (like '0xoooo0020' for space).0x000D0x000A(0xoooo itself is changed into 0xoooooooo before conversion takes place.)0x000D0x000A0x000D0x000ATODO: Change into disallowed chars instead (actually only '0x003B' (semicolon) and '\r' (carriage return) / '\n' (new line) are disallowed).0x000D0x000ATODO: And as UTF-8 encoding is used throughout AgoRapide (see -DefaultAgoRapideEncoding-) other characters0x000D0x000ATODO: in general can be represented.0x000D0x000A0x000D0x000ANOTE: You can typically replace this function with the following single liner in C#:0x000D0x000ANOTE:0x000D0x000ANOTE:   ...value.Replace("0xoooo","0xoooooooo").Replace("\r", "0xoooo000D").Replace("\n", "0xoooo000A").Replace("0x003B", "0xoooo003B")0x000D0x000ANOTE:0x000D0x000ANOTE: That is, encode only line breaks and semicolon.0x000D0x000ANOTE: (the semicolon is related to -WholeCollection-).0x000D0x000A0x000D0x000ANote: -IKCoded- used the same type of encoding but with another set of allowed characters that are not encoded.0x000D0x000A0x000D0x000ASee also -Decode-, -EncodeKeyPart- and -EncodeValues-.0x000D0x000A
EncodeValuePart/__TOCDet/DocFragType = ClassMember
EncodeValuePart/__TOCDet/IsInherited = False
EncodeValuePart/__TOCDet/IsInheritedDoc = False
EncodeValuePart/__TOCDet/Lines = 22
EncodeValuePart/__TOCDet/Name = EncodeValuePart
EncodeValuePart/__TOCDet/Namespace = ARCCore
EncodeValuePart/__TOCDet/Type = PropertyStreamLine
EncodeValuePart/__TOCDet/Attribute/DeclaringType = PropertyStreamLine
EncodeValuePart/__TOCDet/Attribute/Description = Converts a single value part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-. 0x000D0x000AThe resulting format is supposed to be quite human-readable.0x000D0x000A0x000D0x000AReturns a string containing only characters in -AllowedValueChars-.0x000D0x000AOther characters are represented by '0xoooo' plus their UTF-16 code value as four hex characters (like '0xoooo0020' for space).0x000D0x000A(0xoooo itself is changed into 0xoooooooo before conversion takes place.)0x000D0x000A0x000D0x000ATODO: Change into disallowed chars instead (actually only '0x003B' (semicolon) and '\r' (carriage return) / '\n' (new line) are disallowed).0x000D0x000ATODO: And as UTF-8 encoding is used throughout AgoRapide (see -DefaultAgoRapideEncoding-) other characters0x000D0x000ATODO: in general can be represented.0x000D0x000A0x000D0x000ANOTE: You can typically replace this function with the following single liner in C#:0x000D0x000ANOTE:0x000D0x000ANOTE:   ...value.Replace("0xoooo","0xoooooooo").Replace("\r", "0xoooo000D").Replace("\n", "0xoooo000A").Replace("0x003B", "0xoooo003B")0x000D0x000ANOTE:0x000D0x000ANOTE: That is, encode only line breaks and semicolon.0x000D0x000ANOTE: (the semicolon is related to -WholeCollection-).0x000D0x000A0x000D0x000ANote: -IKCoded- used the same type of encoding but with another set of allowed characters that are not encoded.0x000D0x000A0x000D0x000ASee also -Decode-, -EncodeKeyPart- and -EncodeValues-.0x000D0x000A
EncodeValuePart/__TOCDet/Attribute/MethodName = EncodeValuePart
EncodeValuePart/__TOCDet/Attribute/MethodSignature = System.String EncodeValuePart(System.String)
EncodeValues/__TOCDet/Assembly = ARCCore
EncodeValues/__TOCDet/Description = Typically used when turning -WholeCollection- into a value part of a -PropertyStreamLine-.0x000D0x000AExample: Red0x003BYellow0x003BGreen.0x000D0x000ATODO: Give better example with real need for encoding.
EncodeValues/__TOCDet/DocFragType = ClassMember
EncodeValues/__TOCDet/IsInherited = False
EncodeValues/__TOCDet/IsInheritedDoc = False
EncodeValues/__TOCDet/Lines = 3
EncodeValues/__TOCDet/Name = EncodeValues
EncodeValues/__TOCDet/Namespace = ARCCore
EncodeValues/__TOCDet/Type = PropertyStreamLine
EncodeValues/__TOCDet/Attribute/DeclaringType = PropertyStreamLine
EncodeValues/__TOCDet/Attribute/Description = Typically used when turning -WholeCollection- into a value part of a -PropertyStreamLine-.0x000D0x000AExample: Red0x003BYellow0x003BGreen.0x000D0x000ATODO: Give better example with real need for encoding.
EncodeValues/__TOCDet/Attribute/MethodName = EncodeValues
EncodeValues/__TOCDet/Attribute/MethodSignature = System.String EncodeValues(System.Collections.Generic.IEnumerable0x006010x005BSystem.String0x005D)
ParseAndStore/__TOCDet/Assembly = ARCCore
ParseAndStore/__TOCDet/Description = Note that throws exception if -TryParseAndStore- fails.0x000D0x000AUse -ParseAndStoreFailSafe- instead if this is not desired behaviour.0x000D0x000A
ParseAndStore/__TOCDet/DocFragType = ClassMember
ParseAndStore/__TOCDet/IsInherited = False
ParseAndStore/__TOCDet/IsInheritedDoc = False
ParseAndStore/__TOCDet/Lines = 3
ParseAndStore/__TOCDet/Name = ParseAndStore
ParseAndStore/__TOCDet/Namespace = ARCCore
ParseAndStore/__TOCDet/Type = PropertyStreamLine
ParseAndStore/__TOCDet/Attribute/DeclaringType = PropertyStreamLine
ParseAndStore/__TOCDet/Attribute/Description = Note that throws exception if -TryParseAndStore- fails.0x000D0x000AUse -ParseAndStoreFailSafe- instead if this is not desired behaviour.0x000D0x000A
ParseAndStore/__TOCDet/Attribute/MethodName = ParseAndStore
ParseAndStore/__TOCDet/Attribute/MethodSignature = Void ParseAndStore(ARCCore.IP, System.String)
ParseAndStoreFailSafe/__TOCDet/Assembly = ARCCore
ParseAndStoreFailSafe/__TOCDet/Description = If either parsing or storing fails then this method will call -StoreFailure- in order to keep some track of why parsing or storing failed.0x000D0x000A0x000D0x000AUse -ParseAndStore- instead if you want an exeption being thrown at failure.
ParseAndStoreFailSafe/__TOCDet/DocFragType = ClassMember
ParseAndStoreFailSafe/__TOCDet/IsInherited = False
ParseAndStoreFailSafe/__TOCDet/IsInheritedDoc = False
ParseAndStoreFailSafe/__TOCDet/Lines = 3
ParseAndStoreFailSafe/__TOCDet/Name = ParseAndStoreFailSafe
ParseAndStoreFailSafe/__TOCDet/Namespace = ARCCore
ParseAndStoreFailSafe/__TOCDet/Type = PropertyStreamLine
ParseAndStoreFailSafe/__TOCDet/Attribute/DeclaringType = PropertyStreamLine
ParseAndStoreFailSafe/__TOCDet/Attribute/Description = If either parsing or storing fails then this method will call -StoreFailure- in order to keep some track of why parsing or storing failed.0x000D0x000A0x000D0x000AUse -ParseAndStore- instead if you want an exeption being thrown at failure.
ParseAndStoreFailSafe/__TOCDet/Attribute/MethodName = ParseAndStoreFailSafe
ParseAndStoreFailSafe/__TOCDet/Attribute/MethodSignature = Void ParseAndStoreFailSafe(ARCCore.IP, System.String)
StoreFailSafe/__TOCDet/Assembly = ARCCore
StoreFailSafe/__TOCDet/Description = Stores if possible and fails silently.0x000D0x000A0x000D0x000AIf storing fails then this method will try to store a 'ParseOrStoreFailure'-object at root-level in data storage, with detailed information about what exactly failed.0x000D0x000ASee -StoreFailure- for more information.
StoreFailSafe/__TOCDet/DocFragType = ClassMember
StoreFailSafe/__TOCDet/IsInherited = False
StoreFailSafe/__TOCDet/IsInheritedDoc = False
StoreFailSafe/__TOCDet/Lines = 4
StoreFailSafe/__TOCDet/Name = StoreFailSafe
StoreFailSafe/__TOCDet/Namespace = ARCCore
StoreFailSafe/__TOCDet/Type = PropertyStreamLine
StoreFailSafe/__TOCDet/Attribute/DeclaringType = PropertyStreamLine
StoreFailSafe/__TOCDet/Attribute/Description = Stores if possible and fails silently.0x000D0x000A0x000D0x000AIf storing fails then this method will try to store a 'ParseOrStoreFailure'-object at root-level in data storage, with detailed information about what exactly failed.0x000D0x000ASee -StoreFailure- for more information.
StoreFailSafe/__TOCDet/Attribute/MethodName = StoreFailSafe
StoreFailSafe/__TOCDet/Attribute/MethodSignature = Void StoreFailSafe(ARCCore.IP, ARCCore.PropertyStreamLineParsed)
StoreFailure/__TOCDet/Assembly = ARCCore
StoreFailure/__TOCDet/Description = Stores a 'ParseOrStoreFailure'-object. 0x000D0x000ATODO: Create separate class for this.0x000D0x000A0x000D0x000AStored at root-level in the given data storage, with detailed information about what exactly failed.0x000D0x000A0x000D0x000ANote that the 'ParseOrStoreFailure'-object will overwrite any older such object already written.0x000D0x000AIn other words it gives information about the last property stream line that failed to either parse or store.0x000D0x000A0x000D0x000AThe 'CountStored' property tells how many such objects have been created since the application was initiated.0x000D0x000A0x000D0x000A'ParseOrStoreFailure' object gives an emergency indication that something is wrong with for instance data received through a -Subscription- over the -PropertyStream- without the calling method having to take any action there and then.
StoreFailure/__TOCDet/DocFragType = ClassMember
StoreFailure/__TOCDet/IsInherited = False
StoreFailure/__TOCDet/IsInheritedDoc = False
StoreFailure/__TOCDet/Lines = 11
StoreFailure/__TOCDet/Name = StoreFailure
StoreFailure/__TOCDet/Namespace = ARCCore
StoreFailure/__TOCDet/Type = PropertyStreamLine
StoreFailure/__TOCDet/Attribute/DeclaringType = PropertyStreamLine
StoreFailure/__TOCDet/Attribute/Description = Stores a 'ParseOrStoreFailure'-object. 0x000D0x000ATODO: Create separate class for this.0x000D0x000A0x000D0x000AStored at root-level in the given data storage, with detailed information about what exactly failed.0x000D0x000A0x000D0x000ANote that the 'ParseOrStoreFailure'-object will overwrite any older such object already written.0x000D0x000AIn other words it gives information about the last property stream line that failed to either parse or store.0x000D0x000A0x000D0x000AThe 'CountStored' property tells how many such objects have been created since the application was initiated.0x000D0x000A0x000D0x000A'ParseOrStoreFailure' object gives an emergency indication that something is wrong with for instance data received through a -Subscription- over the -PropertyStream- without the calling method having to take any action there and then.
StoreFailure/__TOCDet/Attribute/MethodName = StoreFailure
StoreFailure/__TOCDet/Attribute/MethodSignature = Void StoreFailure(ARCCore.IP, System.String, System.String, System.String)
TryParseDirectToIP/__TOCDet/Assembly = ARCCore
TryParseDirectToIP/__TOCDet/Description = Parses a series of -PropertyStreamLine- directly to the given type of -IP-.0x000D0x000A0x000D0x000ATypical usage would be parsing a series of configuration values.0x000D0x000A0x000D0x000AExample:0x000D0x000AGiven some values known to describe an -ConnectionInstruction- like:0x000D0x000AServerHostName = localhost0x000D0x000AServerPortNo = 42460x000D0x000ADataTransferDirection = Receive0x000D0x000Athis method can return a -ConnectionInstruction- directly.0x000D0x000A0x000D0x000ASee also -dtr- and -TryParseDtr-.0x000D0x000A
TryParseDirectToIP/__TOCDet/DocFragType = ClassMember
TryParseDirectToIP/__TOCDet/IsInherited = False
TryParseDirectToIP/__TOCDet/IsInheritedDoc = False
TryParseDirectToIP/__TOCDet/Lines = 13
TryParseDirectToIP/__TOCDet/Name = TryParseDirectToIP
TryParseDirectToIP/__TOCDet/Namespace = ARCCore
TryParseDirectToIP/__TOCDet/Type = PropertyStreamLine
TryParseDirectToIP/__TOCDet/Attribute/DeclaringType = PropertyStreamLine
TryParseDirectToIP/__TOCDet/Attribute/Description = Parses a series of -PropertyStreamLine- directly to the given type of -IP-.0x000D0x000A0x000D0x000ATypical usage would be parsing a series of configuration values.0x000D0x000A0x000D0x000AExample:0x000D0x000AGiven some values known to describe an -ConnectionInstruction- like:0x000D0x000AServerHostName = localhost0x000D0x000AServerPortNo = 42460x000D0x000ADataTransferDirection = Receive0x000D0x000Athis method can return a -ConnectionInstruction- directly.0x000D0x000A0x000D0x000ASee also -dtr- and -TryParseDtr-.0x000D0x000A
TryParseDirectToIP/__TOCDet/Attribute/MethodName = TryParseDirectToIP
TryParseDirectToIP/__TOCDet/Attribute/MethodSignature = Boolean TryParseDirectToIP0x005BT0x005D(System.Collections.Generic.IEnumerable0x006010x005BSystem.String0x005D, T ByRef, System.String ByRef)
TryParseDirectToProperty/__TOCDet/Assembly = ARCCore
TryParseDirectToProperty/__TOCDet/Description = Parses direct to a given property value.0x000D0x000AThe -PropertyStreamLine- parameter is supposed to consist of only key = value, like 'DataTransferDirection = Receive'.0x000D0x000A0x000D0x000ANot implemented as of May 2020
TryParseDirectToProperty/__TOCDet/DocFragType = ClassMember
TryParseDirectToProperty/__TOCDet/IsInherited = False
TryParseDirectToProperty/__TOCDet/IsInheritedDoc = False
TryParseDirectToProperty/__TOCDet/Lines = 4
TryParseDirectToProperty/__TOCDet/Name = TryParseDirectToProperty
TryParseDirectToProperty/__TOCDet/Namespace = ARCCore
TryParseDirectToProperty/__TOCDet/Type = PropertyStreamLine
TryParseDirectToProperty/__TOCDet/Attribute/DeclaringType = PropertyStreamLine
TryParseDirectToProperty/__TOCDet/Attribute/Description = Parses direct to a given property value.0x000D0x000AThe -PropertyStreamLine- parameter is supposed to consist of only key = value, like 'DataTransferDirection = Receive'.0x000D0x000A0x000D0x000ANot implemented as of May 2020
TryParseDirectToProperty/__TOCDet/Attribute/MethodName = TryParseDirectToProperty
TryParseDirectToProperty/__TOCDet/Attribute/MethodSignature = Boolean TryParseDirectToProperty0x005BT0x005D(System.Object, System.String, T ByRef, System.String ByRef)
TryStore/__TOCDet/Assembly = ARCCore
TryStore/__TOCDet/Description = Stores the given -PropertyStreamLineParsed- in the given storage object.0x000D0x000A0x000D0x000AThis is AgoRapide's main deserialization mechanism (together with -TryParse-).0x000D0x000AThe main serialization mechanism is -ToPropertyStream-0x000D0x000A0x000D0x000ASupposed to be called repeatedly by some mechanism listening to the -PropertyStream-, resulting in a 'complete' object representation being built up.0x000D0x000AThat is, turning the very basic -PropertyStreamLine- format into a more usable object oriented format for in-memory processing of data.0x000D0x000A0x000D0x000ATODO: Build in support for transactions. See for -PropertyStream- TODO: 'FAQ: Can the property stream format support transactions'0x000D0x000ATODO: for an outline about how this can be done.0x000D0x000ATODO: Consider having short-cut 'SetML' in IP (SetML = Set multi-level) which just calls this method.0x000D0x000A0x000D0x000AParses the actual property-value (-Value-) with help of -TryValidateAndParse- (if a corresponding -PK- is found. 0x000D0x000APossible fail scenarios are:0x000D0x000A0x000D0x000A1) Creation of hierarchical keys. Call to -TrySetP- may fail.0x000D0x000ANote that in general no validation is done for the keys, so for instance a misspelling of Customer as 'Customr/42/FirstName = John' will be accepted and stored accordingly (unless the actual storage has implemented some restrictions for what keys to accept).0x000D0x000A0x000D0x000A2) The final value parsing (and then only if a -PK- is found). Call to -TryValidateAndParse- may fail.0x000D0x000A0x000D0x000A3) The final value setting. Call to -TrySetP- may fail.0x000D0x000A0x000D0x000AThe value is stored by call to -TrySetP-.0x000D0x000AThis means that repeated occurrences of the same value will overwrite older ones.0x000D0x000AExample, for the following property stream lines:0x000D0x000A'Customer/42/FirstName = John'0x000D0x000A'...' (some other property stream lines)0x000D0x000A'Customer/42/FirstName = Johnny'0x000D0x000Athe final value of Customer/42/FirstName will be 'Johnny'.0x000D0x000A0x000D0x000ANote that the parsing concept is inherently not thread-safe and this method should therefore only be called within a single-threaded context (see -SingleThreadedCode-).0x000D0x000A
TryStore/__TOCDet/DocFragType = ClassMember
TryStore/__TOCDet/IsInherited = False
TryStore/__TOCDet/IsInheritedDoc = False
TryStore/__TOCDet/Lines = 32
TryStore/__TOCDet/Name = TryStore
TryStore/__TOCDet/Namespace = ARCCore
TryStore/__TOCDet/Type = PropertyStreamLine
TryStore/__TOCDet/Attribute/DeclaringType = PropertyStreamLine
TryStore/__TOCDet/Attribute/Description = Stores the given -PropertyStreamLineParsed- in the given storage object.0x000D0x000A0x000D0x000AThis is AgoRapide's main deserialization mechanism (together with -TryParse-).0x000D0x000AThe main serialization mechanism is -ToPropertyStream-0x000D0x000A0x000D0x000ASupposed to be called repeatedly by some mechanism listening to the -PropertyStream-, resulting in a 'complete' object representation being built up.0x000D0x000AThat is, turning the very basic -PropertyStreamLine- format into a more usable object oriented format for in-memory processing of data.0x000D0x000A0x000D0x000ATODO: Build in support for transactions. See for -PropertyStream- TODO: 'FAQ: Can the property stream format support transactions'0x000D0x000ATODO: for an outline about how this can be done.0x000D0x000ATODO: Consider having short-cut 'SetML' in IP (SetML = Set multi-level) which just calls this method.0x000D0x000A0x000D0x000AParses the actual property-value (-Value-) with help of -TryValidateAndParse- (if a corresponding -PK- is found. 0x000D0x000APossible fail scenarios are:0x000D0x000A0x000D0x000A1) Creation of hierarchical keys. Call to -TrySetP- may fail.0x000D0x000ANote that in general no validation is done for the keys, so for instance a misspelling of Customer as 'Customr/42/FirstName = John' will be accepted and stored accordingly (unless the actual storage has implemented some restrictions for what keys to accept).0x000D0x000A0x000D0x000A2) The final value parsing (and then only if a -PK- is found). Call to -TryValidateAndParse- may fail.0x000D0x000A0x000D0x000A3) The final value setting. Call to -TrySetP- may fail.0x000D0x000A0x000D0x000AThe value is stored by call to -TrySetP-.0x000D0x000AThis means that repeated occurrences of the same value will overwrite older ones.0x000D0x000AExample, for the following property stream lines:0x000D0x000A'Customer/42/FirstName = John'0x000D0x000A'...' (some other property stream lines)0x000D0x000A'Customer/42/FirstName = Johnny'0x000D0x000Athe final value of Customer/42/FirstName will be 'Johnny'.0x000D0x000A0x000D0x000ANote that the parsing concept is inherently not thread-safe and this method should therefore only be called within a single-threaded context (see -SingleThreadedCode-).0x000D0x000A
TryStore/__TOCDet/Attribute/MethodName = TryStore
TryStore/__TOCDet/Attribute/MethodSignature = Boolean TryStore(ARCCore.IP, ARCCore.PropertyStreamLineParsed, System.String ByRef)

Edit single sub keys only: __TOCDet / AllowedKeyChars / AllowedValueChars / Decode / EncodeKeyPart / EncodeKeys / EncodeValuePart / EncodeValues / ParseAndStore / ParseAndStoreFailSafe / StoreFailSafe / StoreFailure / TryParseDirectToIP / TryParseDirectToProperty / TryStore

Generated 2025-05-23 14:37:18.967 UTC