/ doc / toc / ARCQuery / Class / CompoundKey

CompoundKey

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 = ARCQuery
__TOCDet/Description = A class able to expand the concept of entity keys.0x000D0x000A0x000D0x000AExample: In addition to ordinary keys for 'Customer' like 'FirstName', 'LastName' and 'DateOfBirth', it is able to offer:0x000D0x000A1) Expressions like "FirstName'+' '+'LastName" (see -BinaryOperatorKey- and -ConstantKey-).0x000D0x000A2) Keys implemented directly in actual class like 'Name' (see -EntityMethodKey-).0x000D0x000A3) Functions acting on keys, like 'DateOfBirth.Year()' (see -FunctionKey- / -FunctionKeyYear-).0x000D0x000A4) Global new keys like 'CountP()' (see -NewKey- / -NewKeyCountP-).0x000D0x000A5) Foreign keys with for instance aggregations like 'Order.Amount.Sum()' (see -ForeignKey- / -FunctionKeyAggregate- / -FunctionKeyAggregateSum).0x000D0x000A0x000D0x000AThese keys / expressions can then be used whenever ordinary keys are used, like in -QueryExpression-s like SELECT, WHERE, AGGREGATE, PIVOT and so on.0x000D0x000A0x000D0x000AMost relevant sub classes of -CompoundKey- are:0x000D0x000A0x000D0x000A1) -BinaryOperatorKey-: Offers expressions with operators like +, -, * and /.0x000D0x000A0x000D0x000A2) -ConstantKey-: Represents a constant expression like "' '", "', '", "42".0x000D0x000A0x000D0x000A3) -EntityMethodKey-: Key able to call read-only methods defined in the entity class with names like 'TryGet0x007BFieldName0x007D'.0x000D0x000AExample: For 'Customer' it can find 'Customer.Name' which is calculated in a read-only method Customer.TryGetName as combination of 'FirstName', 'LastName' and 'CompanyName'.0x000D0x000A0x000D0x000A4) -NewKey-: Creates new keys available for all entities.0x000D0x000AExample: For 'Customer' it can count number of properties through 'CountP' (see -NewKeyCountP-.)0x000D0x000A0x000D0x000A5) -ForeignKey-: Can find related values.0x000D0x000AExample: For 'Order', it can find 'Customer.Name'.0x000D0x000A0x000D0x000A6) -MemberEntityKey-: Can find value for entity which is member of entity being queried.0x000D0x000AExample: For 'Order', it can find 'Customer.Name'.0x000D0x000A0x000D0x000AClosely related classes (Stored inside -CompoundKey- as members -FunctionKeys-, and -QuantileKey-) are:0x000D0x000A1) -FunctionKey- / -FunctionKeyAggregate-: Extracts data from an already existing value like 'Created.Year()' (see -FunctionKeyYear-)0x000D0x000Aand0x000D0x000A2) -QuantileKey-: Can separate entities into quantiles, like Quartiles, Quintiles or Sextiles0x000D0x000A0x000D0x000A(See also -ValueComparer- which can evaluation expressions like for 'Customer': 'WHERE Created = ThisYear')0x000D0x000A0x000D0x000AOther sub-classes of -CompoundKey- are -OrdinaryKeyPlusFunctionOrQuantile- and -CompoundInvalidKey-.0x000D0x000A0x000D0x000ASee common parser for all compound keys (-Parse-) which will always 'succeed' (a 'TryParse'-method is neither needed nor offered, -CompoundInvalidKey- is returned if not key found).0x000D0x000A0x000D0x000ANote how compound keys (and related keys) may be chained several levels deep, like for 'Order': 'Customer.Created.Year()' or for 'Customer': 'Order.Amount.Sum()' or even 'Order.Amount.Sum().QUARTILE'.0x000D0x000AThis is all parsed in -Parse- and stored in -FunctionKeys- / -QuantileKey-.0x000D0x000A0x000D0x000ASee -QueryExpressionSelect- for hint about using 'AS'-clause in order to simplify parsing and evaluation in subsequent -QueryExpression-s when using -CompoundKey-.0x000D0x000A0x000D0x000AAll keys can be followed by one or several -FunctionKey-s0x000D0x000A0x000D0x000AA -QuantileKey- can only be the last key in a chain, like 'Customer.Order.Amount.Sum().QUARTILE'.0x000D0x000AIt is not evaluated by -CompoundKey-.-TryGetP-, it is instead evaluated by -ARCQuery-. -Extensions-.-TryGetP-)0x000D0x000A0x000D0x000A
__TOCDet/DocFragType = Class
__TOCDet/Name = CompoundKey
__TOCDet/Namespace = ARCQuery
__TOCDet/Type = CompoundKey
__TOCDet/Attribute/AssemblyName = ARCQuery
__TOCDet/Attribute/ClassNamespace = ARCQuery
__TOCDet/Attribute/ClassType = CompoundKey
__TOCDet/Attribute/Description = A class able to expand the concept of entity keys.0x000D0x000A0x000D0x000AExample: In addition to ordinary keys for 'Customer' like 'FirstName', 'LastName' and 'DateOfBirth', it is able to offer:0x000D0x000A1) Expressions like "FirstName'+' '+'LastName" (see -BinaryOperatorKey- and -ConstantKey-).0x000D0x000A2) Keys implemented directly in actual class like 'Name' (see -EntityMethodKey-).0x000D0x000A3) Functions acting on keys, like 'DateOfBirth.Year()' (see -FunctionKey- / -FunctionKeyYear-).0x000D0x000A4) Global new keys like 'CountP()' (see -NewKey- / -NewKeyCountP-).0x000D0x000A5) Foreign keys with for instance aggregations like 'Order.Amount.Sum()' (see -ForeignKey- / -FunctionKeyAggregate- / -FunctionKeyAggregateSum).0x000D0x000A0x000D0x000AThese keys / expressions can then be used whenever ordinary keys are used, like in -QueryExpression-s like SELECT, WHERE, AGGREGATE, PIVOT and so on.0x000D0x000A0x000D0x000AMost relevant sub classes of -CompoundKey- are:0x000D0x000A0x000D0x000A1) -BinaryOperatorKey-: Offers expressions with operators like +, -, * and /.0x000D0x000A0x000D0x000A2) -ConstantKey-: Represents a constant expression like "' '", "', '", "42".0x000D0x000A0x000D0x000A3) -EntityMethodKey-: Key able to call read-only methods defined in the entity class with names like 'TryGet0x007BFieldName0x007D'.0x000D0x000AExample: For 'Customer' it can find 'Customer.Name' which is calculated in a read-only method Customer.TryGetName as combination of 'FirstName', 'LastName' and 'CompanyName'.0x000D0x000A0x000D0x000A4) -NewKey-: Creates new keys available for all entities.0x000D0x000AExample: For 'Customer' it can count number of properties through 'CountP' (see -NewKeyCountP-.)0x000D0x000A0x000D0x000A5) -ForeignKey-: Can find related values.0x000D0x000AExample: For 'Order', it can find 'Customer.Name'.0x000D0x000A0x000D0x000A6) -MemberEntityKey-: Can find value for entity which is member of entity being queried.0x000D0x000AExample: For 'Order', it can find 'Customer.Name'.0x000D0x000A0x000D0x000AClosely related classes (Stored inside -CompoundKey- as members -FunctionKeys-, and -QuantileKey-) are:0x000D0x000A1) -FunctionKey- / -FunctionKeyAggregate-: Extracts data from an already existing value like 'Created.Year()' (see -FunctionKeyYear-)0x000D0x000Aand0x000D0x000A2) -QuantileKey-: Can separate entities into quantiles, like Quartiles, Quintiles or Sextiles0x000D0x000A0x000D0x000A(See also -ValueComparer- which can evaluation expressions like for 'Customer': 'WHERE Created = ThisYear')0x000D0x000A0x000D0x000AOther sub-classes of -CompoundKey- are -OrdinaryKeyPlusFunctionOrQuantile- and -CompoundInvalidKey-.0x000D0x000A0x000D0x000ASee common parser for all compound keys (-Parse-) which will always 'succeed' (a 'TryParse'-method is neither needed nor offered, -CompoundInvalidKey- is returned if not key found).0x000D0x000A0x000D0x000ANote how compound keys (and related keys) may be chained several levels deep, like for 'Order': 'Customer.Created.Year()' or for 'Customer': 'Order.Amount.Sum()' or even 'Order.Amount.Sum().QUARTILE'.0x000D0x000AThis is all parsed in -Parse- and stored in -FunctionKeys- / -QuantileKey-.0x000D0x000A0x000D0x000ASee -QueryExpressionSelect- for hint about using 'AS'-clause in order to simplify parsing and evaluation in subsequent -QueryExpression-s when using -CompoundKey-.0x000D0x000A0x000D0x000AAll keys can be followed by one or several -FunctionKey-s0x000D0x000A0x000D0x000AA -QuantileKey- can only be the last key in a chain, like 'Customer.Order.Amount.Sum().QUARTILE'.0x000D0x000AIt is not evaluated by -CompoundKey-.-TryGetP-, it is instead evaluated by -ARCQuery-. -Extensions-.-TryGetP-)0x000D0x000A0x000D0x000A
__TOCDet/Attribute/SubTypes = BinaryOperatorKey0x003BCompoundInvalidKey0x003BConstantKey0xoooo003CT0xoooo003E0x003BEntityMethodKey0x003BForeignKey0x003BMemberEntityKey0x003BNewKey0x003BNewKeyCountP0x003BNewKeyCountPRec0x003BNewKeyGetType0x003BNewKeyToPropertyStream0x003BOrdinaryKeyPlusFunctionOrQuantile
FunctionKeys/__TOCDet/Assembly = ARCQuery
FunctionKeys/__TOCDet/Description = All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).0x000D0x000A0x000D0x000AExample: For 'Customer', 'Created.Year()' (see -FunctionKeyYear-)0x000D0x000AMultiple function keys may be chained, like for instance0x000D0x000Afor 'Customer', 'Created.Year().Format("00")' (note, this example is contrived, because as of Jul 2020 there is no Format-function available).0x000D0x000A0x000D0x000ATODO: Introduce into constructor in order to make this class immutable.
FunctionKeys/__TOCDet/DocFragType = ClassMember
FunctionKeys/__TOCDet/IsInherited = False
FunctionKeys/__TOCDet/IsInheritedDoc = False
FunctionKeys/__TOCDet/Lines = 7
FunctionKeys/__TOCDet/Name = FunctionKeys
FunctionKeys/__TOCDet/Namespace = ARCQuery
FunctionKeys/__TOCDet/Type = CompoundKey
FunctionKeys/__TOCDet/Attribute/DeclaringType = CompoundKey
FunctionKeys/__TOCDet/Attribute/Description = All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).0x000D0x000A0x000D0x000AExample: For 'Customer', 'Created.Year()' (see -FunctionKeyYear-)0x000D0x000AMultiple function keys may be chained, like for instance0x000D0x000Afor 'Customer', 'Created.Year().Format("00")' (note, this example is contrived, because as of Jul 2020 there is no Format-function available).0x000D0x000A0x000D0x000ATODO: Introduce into constructor in order to make this class immutable.
FunctionKeys/__TOCDet/Attribute/MethodName = FunctionKeys
FunctionKeys/__TOCDet/Attribute/MethodSignature = System.Collections.Generic.IEnumerable0x006010x005BARCQuery.FunctionKey0x005D FunctionKeys
Parse/__TOCDet/Assembly = ARCQuery
Parse/__TOCDet/Description = Note that no TryParse is offered here, because Parse will always succeed (it just returns -CompoundInvalidKey- if 'fails').0x000D0x000A0x000D0x000ACalled from -TryGetP- when that fails to find the given key for the entity. In other words, when the key does not exist direct on the entity, it tries to parse it as a -CompoundKey- instead.0x000D0x000A
Parse/__TOCDet/DocFragType = ClassMember
Parse/__TOCDet/IsInherited = False
Parse/__TOCDet/IsInheritedDoc = False
Parse/__TOCDet/Lines = 4
Parse/__TOCDet/Name = Parse
Parse/__TOCDet/Namespace = ARCQuery
Parse/__TOCDet/Type = CompoundKey
Parse/__TOCDet/Attribute/DeclaringType = CompoundKey
Parse/__TOCDet/Attribute/Description = Note that no TryParse is offered here, because Parse will always succeed (it just returns -CompoundInvalidKey- if 'fails').0x000D0x000A0x000D0x000ACalled from -TryGetP- when that fails to find the given key for the entity. In other words, when the key does not exist direct on the entity, it tries to parse it as a -CompoundKey- instead.0x000D0x000A
Parse/__TOCDet/Attribute/MethodName = Parse
Parse/__TOCDet/Attribute/MethodSignature = ARCQuery.CompoundKey Parse(ARCCore.IP, System.String, System.Type)
QuantileKey/__TOCDet/Assembly = ARCQuery
QuantileKey/__TOCDet/Description = Eventual final -QuantileKey- at end of compound key.0x000D0x000A0x000D0x000AExample: For 'Customer', DateOfBirth.Year().QUARTILE.0x000D0x000AExample: For 'Order', Sum.TERTILE.0x000D0x000A0x000D0x000ANote that this is not evaluated through -CompoundKey-.-TryGetP- (in contrast to -FunctionKeys-), instead -QuantileKey-.-TryGetP- is called with a compound key parameter.(This is done in -ARCQuery-.-Extensions-.-TryGetP-).0x000D0x000A0x000D0x000ATODO: Introduce into constructor in order to make this class immutable.
QuantileKey/__TOCDet/DocFragType = ClassMember
QuantileKey/__TOCDet/IsInherited = False
QuantileKey/__TOCDet/IsInheritedDoc = False
QuantileKey/__TOCDet/Lines = 8
QuantileKey/__TOCDet/Name = QuantileKey
QuantileKey/__TOCDet/Namespace = ARCQuery
QuantileKey/__TOCDet/Type = CompoundKey
QuantileKey/__TOCDet/Attribute/DeclaringType = CompoundKey
QuantileKey/__TOCDet/Attribute/Description = Eventual final -QuantileKey- at end of compound key.0x000D0x000A0x000D0x000AExample: For 'Customer', DateOfBirth.Year().QUARTILE.0x000D0x000AExample: For 'Order', Sum.TERTILE.0x000D0x000A0x000D0x000ANote that this is not evaluated through -CompoundKey-.-TryGetP- (in contrast to -FunctionKeys-), instead -QuantileKey-.-TryGetP- is called with a compound key parameter.(This is done in -ARCQuery-.-Extensions-.-TryGetP-).0x000D0x000A0x000D0x000ATODO: Introduce into constructor in order to make this class immutable.
QuantileKey/__TOCDet/Attribute/MethodName = QuantileKey
QuantileKey/__TOCDet/Attribute/MethodSignature = ARCQuery.QuantileKey QuantileKey
ToString/__TOCDet/Assembly = ARCQuery
ToString/__TOCDet/Description = The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT 0x007BfieldName0x007D'.0x000D0x000A0x000D0x000ANOTE: Implementing classes should append return value with result from -BaseToString-
ToString/__TOCDet/DocFragType = ClassMember
ToString/__TOCDet/IsInherited = False
ToString/__TOCDet/IsInheritedDoc = False
ToString/__TOCDet/Lines = 3
ToString/__TOCDet/Name = ToString
ToString/__TOCDet/Namespace = ARCQuery
ToString/__TOCDet/Type = CompoundKey
ToString/__TOCDet/Attribute/DeclaringType = CompoundKey
ToString/__TOCDet/Attribute/Description = The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT 0x007BfieldName0x007D'.0x000D0x000A0x000D0x000ANOTE: Implementing classes should append return value with result from -BaseToString-
ToString/__TOCDet/Attribute/MethodName = ToString
ToString/__TOCDet/Attribute/MethodSignature = System.String ToString()
TryGetP/__TOCDet/Assembly = ARCQuery
TryGetP/__TOCDet/Description = The outwards facing executor, understanding use of -FunctionKeys-.0x000D0x000A
TryGetP/__TOCDet/DocFragType = ClassMember
TryGetP/__TOCDet/IsInherited = False
TryGetP/__TOCDet/IsInheritedDoc = False
TryGetP/__TOCDet/Lines = 2
TryGetP/__TOCDet/Name = TryGetP
TryGetP/__TOCDet/Namespace = ARCQuery
TryGetP/__TOCDet/Type = CompoundKey
TryGetP/__TOCDet/Attribute/DeclaringType = CompoundKey
TryGetP/__TOCDet/Attribute/Description = The outwards facing executor, understanding use of -FunctionKeys-.0x000D0x000A
TryGetP/__TOCDet/Attribute/MethodName = TryGetP
TryGetP/__TOCDet/Attribute/MethodSignature = Boolean TryGetP(ARCCore.IKIP, ARCCore.IP, ARCCore.IP ByRef, System.String ByRef)
TryGetPInternal/__TOCDet/Assembly = ARCQuery
TryGetPInternal/__TOCDet/Description = The internal executor, containing the specific functionality for how to evaluate the key.
TryGetPInternal/__TOCDet/DocFragType = ClassMember
TryGetPInternal/__TOCDet/IsInherited = False
TryGetPInternal/__TOCDet/IsInheritedDoc = False
TryGetPInternal/__TOCDet/Lines = 1
TryGetPInternal/__TOCDet/Name = TryGetPInternal
TryGetPInternal/__TOCDet/Namespace = ARCQuery
TryGetPInternal/__TOCDet/Type = CompoundKey
TryGetPInternal/__TOCDet/Attribute/DeclaringType = CompoundKey
TryGetPInternal/__TOCDet/Attribute/Description = The internal executor, containing the specific functionality for how to evaluate the key.
TryGetPInternal/__TOCDet/Attribute/MethodName = TryGetPInternal
TryGetPInternal/__TOCDet/Attribute/MethodSignature = Boolean TryGetPInternal(ARCCore.IKIP, ARCCore.IP, ARCCore.IP ByRef, System.String ByRef)

Edit single sub keys only: __TOCDet / FunctionKeys / Parse / QuantileKey / ToString / TryGetP / TryGetPInternal

Generated 2025-05-23 08:04:59.104 UTC