/ doc / toc / ARCQuery / Class / QueryExpressionHint

QueryExpressionHint

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 = Describes if hints are to be generated (as query progresses) for potential new queries.0x000D0x000A0x000D0x000ASpecified through -QueryExpressionHint- and stored in -CreateHints-.0x000D0x000ADoes not affect query result in itself, only its presentation0x000D0x000A0x000D0x000ASet to OFF if hints are not needed (for instance if consumer of query is not a human). This will slightly improve performance.0x000D0x000A0x000D0x000ASee -QueryExpressionWithSuggestions-.0x000D0x000A0x000D0x000ASee -SyntaxHelp-.
__TOCDet/DocFragType = Class
__TOCDet/Name = QueryExpressionHint
__TOCDet/Namespace = ARCQuery
__TOCDet/Type = QueryExpressionHint
__TOCDet/Attribute/AssemblyName = ARCQuery
__TOCDet/Attribute/BaseTypes = QueryExpression
__TOCDet/Attribute/ClassNamespace = ARCQuery
__TOCDet/Attribute/ClassType = QueryExpressionHint
__TOCDet/Attribute/Description = Describes if hints are to be generated (as query progresses) for potential new queries.0x000D0x000A0x000D0x000ASpecified through -QueryExpressionHint- and stored in -CreateHints-.0x000D0x000ADoes not affect query result in itself, only its presentation0x000D0x000A0x000D0x000ASet to OFF if hints are not needed (for instance if consumer of query is not a human). This will slightly improve performance.0x000D0x000A0x000D0x000ASee -QueryExpressionWithSuggestions-.0x000D0x000A0x000D0x000ASee -SyntaxHelp-.
__TOCDet/Attribute/Interfaces = ITypeDescriber0x003BIEquatable0xoooo003CQueryExpression0xoooo003E
Execute/__TOCDet/Assembly = ARCQuery
Execute/__TOCDet/Description = Transforms the given input collection into a resulting collection.0x000D0x000A0x000D0x000AThe parameter data storage is used for sub classes implementing relations (transforming to collections of other types).0x000D0x000A0x000D0x000ATODO: Most probably we also need a parameter for what entity type the input collection represents TODO: (one might of course sample it, but the calling method should know anyway). 0x000D0x000ATODO: It is possible also that we need a parameter for current LinkContext, or OR TODO: rather, let parameter DataStorage just be the same where we find the key of the current entity type TODO: and assume that other entity collections are stored at the same level.0x000D0x000ATODO:0x000D0x000ATODO: SOLUTION: QueryCollection-class with all necessary parameters. This also enables0x000D0x000ATODO: method chaining (fluent interface) AND logging AND timing AND exception handling AND so on AND so on.0x000D0x000ATODO:0x000D0x000ATODO: Each Query-implementation adds an Extension method against QueryCollection.0x000D0x000ATODO: QueryCollection itself is IP, with keys for log-data and a Result-key.
Execute/__TOCDet/DocFragType = ClassMember
Execute/__TOCDet/IsInherited = False
Execute/__TOCDet/IsInheritedDoc = True
Execute/__TOCDet/Name = Execute
Execute/__TOCDet/Namespace = ARCQuery
Execute/__TOCDet/Type = QueryExpressionHint
Execute/__TOCDet/Attribute/DeclaringType = QueryExpression
Execute/__TOCDet/Attribute/Description = Transforms the given input collection into a resulting collection.0x000D0x000A0x000D0x000AThe parameter data storage is used for sub classes implementing relations (transforming to collections of other types).0x000D0x000A0x000D0x000ATODO: Most probably we also need a parameter for what entity type the input collection represents TODO: (one might of course sample it, but the calling method should know anyway). 0x000D0x000ATODO: It is possible also that we need a parameter for current LinkContext, or OR TODO: rather, let parameter DataStorage just be the same where we find the key of the current entity type TODO: and assume that other entity collections are stored at the same level.0x000D0x000ATODO:0x000D0x000ATODO: SOLUTION: QueryCollection-class with all necessary parameters. This also enables0x000D0x000ATODO: method chaining (fluent interface) AND logging AND timing AND exception handling AND so on AND so on.0x000D0x000ATODO:0x000D0x000ATODO: Each Query-implementation adds an Extension method against QueryCollection.0x000D0x000ATODO: QueryCollection itself is IP, with keys for log-data and a Result-key.
Execute/__TOCDet/Attribute/MethodName = Execute
Execute/__TOCDet/Attribute/MethodSignature = ARCQuery.QueryExpressionWithSuggestions Execute(ARCQuery.Query)
SyntaxHelp/__TOCDet/Assembly = ARCQuery
SyntaxHelp/__TOCDet/Description = HINT 0x007BON|OFF0x007D0x000D0x000AExamples:0x000D0x000AHINT OFF0x000D0x000AHINT ON
SyntaxHelp/__TOCDet/DocFragType = ClassMember
SyntaxHelp/__TOCDet/IsInherited = False
SyntaxHelp/__TOCDet/IsInheritedDoc = False
SyntaxHelp/__TOCDet/Lines = 4
SyntaxHelp/__TOCDet/Name = SyntaxHelp
SyntaxHelp/__TOCDet/Namespace = ARCQuery
SyntaxHelp/__TOCDet/Type = QueryExpressionHint
SyntaxHelp/__TOCDet/Attribute/DeclaringType = QueryExpressionHint
SyntaxHelp/__TOCDet/Attribute/Description = HINT 0x007BON|OFF0x007D0x000D0x000AExamples:0x000D0x000AHINT OFF0x000D0x000AHINT ON
SyntaxHelp/__TOCDet/Attribute/MethodName = SyntaxHelp
SyntaxHelp/__TOCDet/Attribute/MethodSignature = System.String SyntaxHelp
TryCheckForExistenceOfKey/__TOCDet/Assembly = ARCQuery
TryCheckForExistenceOfKey/__TOCDet/Description = Used by query expressions in order to catch wrong field names used or misspelling of field names.0x000D0x000A0x000D0x000AReturns TRUE if either:0x000D0x000A1) -TryGetFromTypeAndFieldName succeeds (in which case out parameter keyAsPK will be set),0x000D0x000A2) (new from Jan 2022) -AllEntityMethodKeysForEntityTypeDict contains the key,0x000D0x000A3) -CurrentStrictness- = OFF,0x000D0x000A4) -Result- is empty, or,0x000D0x000A5) At least one element in -Result- contains the given key0x000D0x000A0x000D0x000ANote that this check must be deferred to the actual execution of the query, not at -TryParse-, because the query expression mechanism has no concept of for which entity types it operates on.0x000D0x000A0x000D0x000AWill call -ShouldTerminate- if fails to get the key, this again will set -TerminateReason- with detailed information about available keys (that is, with a helpful error message).
TryCheckForExistenceOfKey/__TOCDet/DocFragType = ClassMember
TryCheckForExistenceOfKey/__TOCDet/IsInherited = True
TryCheckForExistenceOfKey/__TOCDet/IsInheritedDoc = True
TryCheckForExistenceOfKey/__TOCDet/Name = TryCheckForExistenceOfKey
TryCheckForExistenceOfKey/__TOCDet/Namespace = ARCQuery
TryCheckForExistenceOfKey/__TOCDet/Type = QueryExpressionHint
TryCheckForExistenceOfKey/__TOCDet/Attribute/DeclaringType = QueryExpression
TryCheckForExistenceOfKey/__TOCDet/Attribute/Description = Used by query expressions in order to catch wrong field names used or misspelling of field names.0x000D0x000A0x000D0x000AReturns TRUE if either:0x000D0x000A1) -TryGetFromTypeAndFieldName succeeds (in which case out parameter keyAsPK will be set),0x000D0x000A2) (new from Jan 2022) -AllEntityMethodKeysForEntityTypeDict contains the key,0x000D0x000A3) -CurrentStrictness- = OFF,0x000D0x000A4) -Result- is empty, or,0x000D0x000A5) At least one element in -Result- contains the given key0x000D0x000A0x000D0x000ANote that this check must be deferred to the actual execution of the query, not at -TryParse-, because the query expression mechanism has no concept of for which entity types it operates on.0x000D0x000A0x000D0x000AWill call -ShouldTerminate- if fails to get the key, this again will set -TerminateReason- with detailed information about available keys (that is, with a helpful error message).
TryCheckForExistenceOfKey/__TOCDet/Attribute/MethodName = TryCheckForExistenceOfKey
TryCheckForExistenceOfKey/__TOCDet/Attribute/MethodSignature = Boolean TryCheckForExistenceOfKey(ARCQuery.Query, ARCCore.IK, ARCCore.PK ByRef)

Edit single sub keys only: __TOCDet / Execute / SyntaxHelp / TryCheckForExistenceOfKey

Generated 2024-05-16 06:01:28.588 UTC