/ doc / toc / ARCQuery / Class / EntityMethodKey

EntityMethodKey

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 = Key able to call read-only methods defined in the entity class with names like 'TryGet0x007BFieldName0x007D'.0x000D0x000A0x000D0x000ASome common usages of this would be to implement:0x000D0x000A- In a class called 'Customer' with 'FirstName' and 'LastName', a new property 'Name'.0x000D0x000A- In a class called 'OrderLine' with 'Quantity' and 'UnitPrice', a new property 'Sum'.0x000D0x000A0x000D0x000AIn essence this is making an entity class able to describe itself, something which is quite natural in many cases.0x000D0x000A0x000D0x000AThe principle can also be used to simplify querying while still having tables normalized.0x000D0x000AIf for instance address data for 'Customer' objects is normalized into a separate table 'Geography' then one could implement properties on 'Customer' like 'City', 'State', 'Country'.0x000D0x000AThis would enable querying for 'Customer' like0x000D0x000A'SELECT Name, Address, City, State, Country'0x000D0x000Ainstead of the more laborous0x000D0x000A'SELECT Geography.Name, Geography.Address, Geography.City, Geography.State, Geography.Country'0x000D0x000A(see -TryGetForeignField- which is a helper method for this purpose).0x000D0x000A0x000D0x000AImplementations of a few such properties can often significantly reduce the complexity of queries / reduce the need for denormalizing tables in the database.0x000D0x000A0x000D0x000AThe risk of bugs are also reduced since the properties will only be defined in one place, as close as possible to its source propertiesinstead of complex query components being repeated multiple times in a reporting system for instance.0x000D0x000A0x000D0x000AIn addition, memory and disk space is conserved because the returned values are usually ephemeral.0x000D0x000APerformance MAY also be increased as the values are only calculated when needed.0x000D0x000A0x000D0x000AThis class (-EntityMethodKey-) looks for such entity property defining methods through reflection. 0x000D0x000AIt is able to call methods with signatures like either:0x000D0x000A  bool TryGet0x007BKeyName0x007D(out IP retval, out string errorResponse) (see -Simple-)0x000D0x000Aor0x000D0x000A  bool TryGet0x007BKeyName0x007D(IP dataStorage, IK thisKey, out IP retval, out string errorResponse) (see -Complex-)0x000D0x000A0x000D0x000AThe second overload makes the entity class able to query other parts of the system in order to calculate the return value.0x000D0x000A0x000D0x000AThese should be read-only methods / read-only properties, that is, they should not change the state of the entity or the data storage.0x000D0x000A0x000D0x000ANote: 'out IP retval' can be any type assignable to -IP-, so it is recommended to use more strongly typing in the method signature, like 'out PValue0x003CDateTime0x003E retval' for instance.0x000D0x000A0x000D0x000ASee also -NewKey- (creating new keys (new fields) for all entity object types).
__TOCDet/DocFragType = Class
__TOCDet/Name = EntityMethodKey
__TOCDet/Namespace = ARCQuery
__TOCDet/Type = EntityMethodKey
__TOCDet/Attribute/AssemblyName = ARCQuery
__TOCDet/Attribute/BaseTypes = CompoundKey
__TOCDet/Attribute/ClassNamespace = ARCQuery
__TOCDet/Attribute/ClassType = EntityMethodKey
__TOCDet/Attribute/Description = Key able to call read-only methods defined in the entity class with names like 'TryGet0x007BFieldName0x007D'.0x000D0x000A0x000D0x000ASome common usages of this would be to implement:0x000D0x000A- In a class called 'Customer' with 'FirstName' and 'LastName', a new property 'Name'.0x000D0x000A- In a class called 'OrderLine' with 'Quantity' and 'UnitPrice', a new property 'Sum'.0x000D0x000A0x000D0x000AIn essence this is making an entity class able to describe itself, something which is quite natural in many cases.0x000D0x000A0x000D0x000AThe principle can also be used to simplify querying while still having tables normalized.0x000D0x000AIf for instance address data for 'Customer' objects is normalized into a separate table 'Geography' then one could implement properties on 'Customer' like 'City', 'State', 'Country'.0x000D0x000AThis would enable querying for 'Customer' like0x000D0x000A'SELECT Name, Address, City, State, Country'0x000D0x000Ainstead of the more laborous0x000D0x000A'SELECT Geography.Name, Geography.Address, Geography.City, Geography.State, Geography.Country'0x000D0x000A(see -TryGetForeignField- which is a helper method for this purpose).0x000D0x000A0x000D0x000AImplementations of a few such properties can often significantly reduce the complexity of queries / reduce the need for denormalizing tables in the database.0x000D0x000A0x000D0x000AThe risk of bugs are also reduced since the properties will only be defined in one place, as close as possible to its source propertiesinstead of complex query components being repeated multiple times in a reporting system for instance.0x000D0x000A0x000D0x000AIn addition, memory and disk space is conserved because the returned values are usually ephemeral.0x000D0x000APerformance MAY also be increased as the values are only calculated when needed.0x000D0x000A0x000D0x000AThis class (-EntityMethodKey-) looks for such entity property defining methods through reflection. 0x000D0x000AIt is able to call methods with signatures like either:0x000D0x000A  bool TryGet0x007BKeyName0x007D(out IP retval, out string errorResponse) (see -Simple-)0x000D0x000Aor0x000D0x000A  bool TryGet0x007BKeyName0x007D(IP dataStorage, IK thisKey, out IP retval, out string errorResponse) (see -Complex-)0x000D0x000A0x000D0x000AThe second overload makes the entity class able to query other parts of the system in order to calculate the return value.0x000D0x000A0x000D0x000AThese should be read-only methods / read-only properties, that is, they should not change the state of the entity or the data storage.0x000D0x000A0x000D0x000ANote: 'out IP retval' can be any type assignable to -IP-, so it is recommended to use more strongly typing in the method signature, like 'out PValue0x003CDateTime0x003E retval' for instance.0x000D0x000A0x000D0x000ASee also -NewKey- (creating new keys (new fields) for all entity object types).
AllEntityMethodKeysForEntityTypeDict/__TOCDet/Assembly = ARCQuery
AllEntityMethodKeysForEntityTypeDict/__TOCDet/Description = Returns all -EntityMethodKey- in the class definition of the given entity type.0x000D0x000A0x000D0x000AKey in returned dictionary is Method Name INCLUDING "TryGet".0x000D0x000A0x000D0x000AUseful in order to give query suggestions to the user for instance.0x000D0x000A0x000D0x000AReturns an empty collection if no methods found.0x000D0x000A0x000D0x000ASee also -AllEntityMethodKeysForEntityTypeList-.0x000D0x000A
AllEntityMethodKeysForEntityTypeDict/__TOCDet/DocFragType = ClassMember
AllEntityMethodKeysForEntityTypeDict/__TOCDet/IsInherited = False
AllEntityMethodKeysForEntityTypeDict/__TOCDet/IsInheritedDoc = False
AllEntityMethodKeysForEntityTypeDict/__TOCDet/Lines = 10
AllEntityMethodKeysForEntityTypeDict/__TOCDet/Name = AllEntityMethodKeysForEntityTypeDict
AllEntityMethodKeysForEntityTypeDict/__TOCDet/Namespace = ARCQuery
AllEntityMethodKeysForEntityTypeDict/__TOCDet/Type = EntityMethodKey
AllEntityMethodKeysForEntityTypeDict/__TOCDet/Attribute/DeclaringType = EntityMethodKey
AllEntityMethodKeysForEntityTypeDict/__TOCDet/Attribute/Description = Returns all -EntityMethodKey- in the class definition of the given entity type.0x000D0x000A0x000D0x000AKey in returned dictionary is Method Name INCLUDING "TryGet".0x000D0x000A0x000D0x000AUseful in order to give query suggestions to the user for instance.0x000D0x000A0x000D0x000AReturns an empty collection if no methods found.0x000D0x000A0x000D0x000ASee also -AllEntityMethodKeysForEntityTypeList-.0x000D0x000A
AllEntityMethodKeysForEntityTypeDict/__TOCDet/Attribute/MethodName = AllEntityMethodKeysForEntityTypeDict
AllEntityMethodKeysForEntityTypeDict/__TOCDet/Attribute/MethodSignature = System.Collections.Generic.Dictionary0x006020x005BSystem.String,ARCQuery.EntityMethodKey0x005D AllEntityMethodKeysForEntityTypeDict(System.Type)
AllEntityMethodKeysForEntityTypeList/__TOCDet/Assembly = ARCQuery
AllEntityMethodKeysForEntityTypeList/__TOCDet/Description = Returns List sorted by Method Name of Value of Dictionary returned by -AllEntityMethodKeysForEntityTypeDict-
AllEntityMethodKeysForEntityTypeList/__TOCDet/DocFragType = ClassMember
AllEntityMethodKeysForEntityTypeList/__TOCDet/IsInherited = False
AllEntityMethodKeysForEntityTypeList/__TOCDet/IsInheritedDoc = False
AllEntityMethodKeysForEntityTypeList/__TOCDet/Lines = 1
AllEntityMethodKeysForEntityTypeList/__TOCDet/Name = AllEntityMethodKeysForEntityTypeList
AllEntityMethodKeysForEntityTypeList/__TOCDet/Namespace = ARCQuery
AllEntityMethodKeysForEntityTypeList/__TOCDet/Type = EntityMethodKey
AllEntityMethodKeysForEntityTypeList/__TOCDet/Attribute/DeclaringType = EntityMethodKey
AllEntityMethodKeysForEntityTypeList/__TOCDet/Attribute/Description = Returns List sorted by Method Name of Value of Dictionary returned by -AllEntityMethodKeysForEntityTypeDict-
AllEntityMethodKeysForEntityTypeList/__TOCDet/Attribute/MethodName = AllEntityMethodKeysForEntityTypeList
AllEntityMethodKeysForEntityTypeList/__TOCDet/Attribute/MethodSignature = System.Collections.Generic.List0x006010x005BARCQuery.EntityMethodKey0x005D AllEntityMethodKeysForEntityTypeList(System.Type)
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 = True
FunctionKeys/__TOCDet/IsInheritedDoc = True
FunctionKeys/__TOCDet/Name = FunctionKeys
FunctionKeys/__TOCDet/Namespace = ARCQuery
FunctionKeys/__TOCDet/Type = EntityMethodKey
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
Method/__TOCDet/Assembly = ARCQuery
Method/__TOCDet/Description = The actuall TryGet method implemented in the relevant entity class.
Method/__TOCDet/DocFragType = ClassMember
Method/__TOCDet/IsInherited = False
Method/__TOCDet/IsInheritedDoc = False
Method/__TOCDet/Lines = 1
Method/__TOCDet/Name = Method
Method/__TOCDet/Namespace = ARCQuery
Method/__TOCDet/Type = EntityMethodKey
Method/__TOCDet/Attribute/DeclaringType = EntityMethodKey
Method/__TOCDet/Attribute/Description = The actuall TryGet method implemented in the relevant entity class.
Method/__TOCDet/Attribute/MethodName = Method
Method/__TOCDet/Attribute/MethodSignature = System.Reflection.MethodInfo Method
MethodNameAsIK/__TOCDet/Assembly = ARCQuery
MethodNameAsIK/__TOCDet/Description = Name of TryGet method but without 'TryGet' in name
MethodNameAsIK/__TOCDet/DocFragType = ClassMember
MethodNameAsIK/__TOCDet/IsInherited = False
MethodNameAsIK/__TOCDet/IsInheritedDoc = False
MethodNameAsIK/__TOCDet/Lines = 1
MethodNameAsIK/__TOCDet/Name = MethodNameAsIK
MethodNameAsIK/__TOCDet/Namespace = ARCQuery
MethodNameAsIK/__TOCDet/Type = EntityMethodKey
MethodNameAsIK/__TOCDet/Attribute/DeclaringType = EntityMethodKey
MethodNameAsIK/__TOCDet/Attribute/Description = Name of TryGet method but without 'TryGet' in name
MethodNameAsIK/__TOCDet/Attribute/MethodName = MethodNameAsIK
MethodNameAsIK/__TOCDet/Attribute/MethodSignature = ARCCore.IK MethodNameAsIK
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 = True
QuantileKey/__TOCDet/IsInheritedDoc = True
QuantileKey/__TOCDet/Name = QuantileKey
QuantileKey/__TOCDet/Namespace = ARCQuery
QuantileKey/__TOCDet/Type = EntityMethodKey
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
ReturnType/__TOCDet/Assembly = ARCQuery
ReturnType/__TOCDet/Description = The type of the 'retval' out-parameter of the method.0x000D0x000A0x000D0x000AThis must be of type IP, often it will be a -PValue- like PValue0x003Cstring0x003E, PValue0x003Clong0x003E or similar.0x000D0x000A
ReturnType/__TOCDet/DocFragType = ClassMember
ReturnType/__TOCDet/IsInherited = False
ReturnType/__TOCDet/IsInheritedDoc = False
ReturnType/__TOCDet/Lines = 4
ReturnType/__TOCDet/Name = ReturnType
ReturnType/__TOCDet/Namespace = ARCQuery
ReturnType/__TOCDet/Type = EntityMethodKey
ReturnType/__TOCDet/Attribute/DeclaringType = EntityMethodKey
ReturnType/__TOCDet/Attribute/Description = The type of the 'retval' out-parameter of the method.0x000D0x000A0x000D0x000AThis must be of type IP, often it will be a -PValue- like PValue0x003Cstring0x003E, PValue0x003Clong0x003E or similar.0x000D0x000A
ReturnType/__TOCDet/Attribute/MethodName = ReturnType
ReturnType/__TOCDet/Attribute/MethodSignature = System.Type ReturnType
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 = True
ToString/__TOCDet/Name = ToString
ToString/__TOCDet/Namespace = ARCQuery
ToString/__TOCDet/Type = EntityMethodKey
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()
TryGetForeignField/__TOCDet/Assembly = ARCQuery
TryGetForeignField/__TOCDet/Description = Returns foreign field through foreign key given.0x000D0x000A0x000D0x000AHelper method not used directly by -EntityMethodKey- but useful for actually implementation methods in entity classes.0x000D0x000A0x000D0x000AFor instance, given 'CustomerP.GeographyId' it can look up values like 'GeographyId.City', 'GeographyId.Province', 'GeographyId.State', 'GeographyId.Country'.0x000D0x000A0x000D0x000AThis enables easier querying without having to denormalize the tables themselves, like when querying for 'Customer', to do0x000D0x000A'SELECT Name, Address, City, State, Country'0x000D0x000Ainstead of the more laborous0x000D0x000A'SELECT Geography.Name, Geography.Address, Geography.City, Geography.State, Geography.Country'0x000D0x000A(the latter approach would have utilized -ForeignKey-).
TryGetForeignField/__TOCDet/DocFragType = ClassMember
TryGetForeignField/__TOCDet/IsInherited = False
TryGetForeignField/__TOCDet/IsInheritedDoc = False
TryGetForeignField/__TOCDet/Lines = 11
TryGetForeignField/__TOCDet/Name = TryGetForeignField
TryGetForeignField/__TOCDet/Namespace = ARCQuery
TryGetForeignField/__TOCDet/Type = EntityMethodKey
TryGetForeignField/__TOCDet/Attribute/DeclaringType = EntityMethodKey
TryGetForeignField/__TOCDet/Attribute/Description = Returns foreign field through foreign key given.0x000D0x000A0x000D0x000AHelper method not used directly by -EntityMethodKey- but useful for actually implementation methods in entity classes.0x000D0x000A0x000D0x000AFor instance, given 'CustomerP.GeographyId' it can look up values like 'GeographyId.City', 'GeographyId.Province', 'GeographyId.State', 'GeographyId.Country'.0x000D0x000A0x000D0x000AThis enables easier querying without having to denormalize the tables themselves, like when querying for 'Customer', to do0x000D0x000A'SELECT Name, Address, City, State, Country'0x000D0x000Ainstead of the more laborous0x000D0x000A'SELECT Geography.Name, Geography.Address, Geography.City, Geography.State, Geography.Country'0x000D0x000A(the latter approach would have utilized -ForeignKey-).
TryGetForeignField/__TOCDet/Attribute/MethodName = TryGetForeignField
TryGetForeignField/__TOCDet/Attribute/MethodSignature = Boolean TryGetForeignField(ARCCore.IP, ARCCore.IP, ARCCore.IK, ARCCore.IK, ARCCore.IP ByRef, System.String ByRef)
TryGetP/__TOCDet/Assembly = ARCQuery
TryGetP/__TOCDet/Description = The outwards facing executor, understanding use of -FunctionKeys-.0x000D0x000A
TryGetP/__TOCDet/DocFragType = ClassMember
TryGetP/__TOCDet/IsInherited = True
TryGetP/__TOCDet/IsInheritedDoc = True
TryGetP/__TOCDet/Name = TryGetP
TryGetP/__TOCDet/Namespace = ARCQuery
TryGetP/__TOCDet/Type = EntityMethodKey
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 = True
TryGetPInternal/__TOCDet/Name = TryGetPInternal
TryGetPInternal/__TOCDet/Namespace = ARCQuery
TryGetPInternal/__TOCDet/Type = EntityMethodKey
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 / AllEntityMethodKeysForEntityTypeDict / AllEntityMethodKeysForEntityTypeList / FunctionKeys / Method / MethodNameAsIK / QuantileKey / ReturnType / ToString / TryGetForeignField / TryGetP / TryGetPInternal

Generated 2024-05-17 11:14:40.388 UTC