| ibi Patterns - Search 6.0.0 .NET API |
| NetricsQuery.setName Method |
| See Also |
 
|
Assign a name to this querylet.
Namespace: NetricsServerInterface
Assembly: NetricsServerInterface (in NetricsServerInterface.dll)
Syntax
| Visual Basic (Declaration) |
|---|
| Public Sub setName( _ ByVal qlet_name As String _ ) |
| C# |
|---|
| public void setName( string qlet_name ) |
| C++ |
|---|
| public: void setName( String qlet_name ) sealed |
| J# |
|---|
| public void setName( string qlet_name ) |
| JScript |
|---|
| public
function setName( qlet_name : String ) |
Parameters
- qlet_name
- The 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. All querylet names assigned within a query tree must be unique. This implies a NetricsQuery object that has been assigned a name can not be used multiple places in a query tree.
Remarks
This call associates the given name with this query. This is used to identify a particular node in a query tree. The name is associated with this particular query node, it is not associated with any sub-nodes under this query or any higher level nodes that include this query.
A name may be associated with any query type, so it can identify a node anywhere on the query tree, a leaf or any score combiner node.
Currently the primary use for assigning a name to a query is to retrieve the match score for the query. A complex query may have many levels on its query tree. The search results return only the top level scores, and the querylet scores the top level query received. If there is a need to retrieve the score for node at a lower level the node should be assigned a name using this method. The match score for the node can be retrieved from the search results using name assigned.