| ibi Patterns - Search 6.0.0 .NET API |
| NetricsQuery.setGroup Method |
| See Also |
 
|
Assign a group to this querylet.
Namespace: NetricsServerInterface
Assembly: NetricsServerInterface (in NetricsServerInterface.dll)
Syntax
| Visual Basic (Declaration) |
|---|
| Public Sub setGroup( _ ByVal qlet_group As String _ ) |
| C# |
|---|
| public void setGroup( string qlet_group ) |
| C++ |
|---|
| public: void setGroup( String qlet_group ) sealed |
| J# |
|---|
| public void setGroup( string qlet_group ) |
| JScript |
|---|
| public
function setGroup( qlet_group : String ) |
Parameters
- qlet_group
- The group name assigned to this querylet. The name is letter case sensitive. It may be any valid string. The UTF-8 encoded value of the name is limited to 999 bytes.
Remarks
This call associates the given group name with this query and all sub-queries of this query.
Grouping is used to identify portions of a query that are to be considered as independent match cases. Each identified group is treated as a separate match case within the over all match. This only pertains to join queries, where a group is associated with a match on a particular child record.
Typically this is used where it is desired to find the best match to an input record that consists of a parent and a set of child records, where there are two or more instances of a child record from the same table. The desire is to find the best match to any one of the multiple child records. A separate querylet would be constructed for each instance of the child record, and then they would be ORed together.
In the above match case the early phase of the matching process will try to find a record that best matches all of the OR cases, leading to poor results. Assigning separate group names to the querylets generated from the separate input child records lets the early phase know these are independent match
record. If it is necessary to generate multiple querylets for a particular child record, where one of these is not going to be a sub-query of the other, than both should be assigned the same group name.
A querylet cannot be assigned to two different groups. Remember that assigning a group name to a NetricsQuery object, also assigns the name to all sub-queries of that object. So if a different group name has been assigned to one of the sub-queries, an exception will be thrown when the query is executed.