Aqualogic Interaction API  
 

IPTSQueryRequest.setResultsGroupBy Method

Set field for results clustering (grouping). A maximum of 10 groups are returned, plus the "all others" group.

For the portal "object type" categorization, use field IPTSPlumtreeCollection.CategorizableObjectType. For the portal's "folder" categorization, use field IPTSPortalCollection.FolderPath.

Any other searchable and retrievable string field may also be used for clustering. In this case, the search server will find the most common terms (words) in the field (within your set of search results). Each group will correspond to one of these common terms, and will contain search results that have the term in the field. Note that a single search result may appear in multiple groups.

For a simple example, suppose that the Name field is used, and documents "Cats Dogs" and "Cats Mice" match the query. The first group will be "Cats" and contain both results. "Dogs" and "Mice" will be the other group, and will each contain one result.

Overload List

Set field for results clustering (grouping). A maximum of 10 groups are returned, plus the "all others" group. For the portal "object type" categorization, use field IPTSPlumtreeCollection.CategorizableObjectType. For the portal's "folder" categorization, use field IPTSPortalCollection.FolderPath. Any other searchable and retrievable string field may also be used for clustering. In this case, the search server will find the most common terms (words) in the field (within your set of search results). Each group will correspond to one of these common terms, and will contain search results that have the term in the field. Note that a single search result may appear in multiple groups. For a simple example, suppose that the Name field is used, and documents "Cats Dogs" and "Cats Mice" match the query. The first group will be "Cats" and contain both results. "Dogs" and "Mice" will be the other group, and will each contain one result.

void setResultsGroupBy(IPTSField);

Set field for results clustering (grouping) and specify the maximum number of desired groups. For the portal "object type" categorization, use field IPTSPlumtreeCollection.CategorizableObjectType. For the portal's "folder" categorization, use field IPTSPortalCollection.FolderPath. Any other searchable and retrievable string field may also be used for clustering. In this case, the search server will find the most common terms (words) in the field (within your set of search results). Each group will correspond to one of these common terms, and will contain search results that have the term in the field. Note that a single search result may appear in multiple groups. For a simple example, suppose that the Name field is used, and documents "Cats Dogs" and "Cats Mice" match the query. The first group will be "Cats" and contain both results. "Dogs" and "Mice" will be the other group, and will each contain one result.

void setResultsGroupBy(IPTSField,int);

See Also

IPTSQueryRequest Interface | com.plumtree.server.search Namespace