Eclipse Platform
Release 3.1

org.eclipse.search.ui
Interface IGroupByKeyComputer


Deprecated. Part of the old ('classic') search result view. Since 3.0 clients can create their own search result view pages (see ISearchResultPage), leaving it up to the page how to group search results.

public interface IGroupByKeyComputer

Computes the key by which the markers in the search result view are grouped.

Clients may implement this interface.


Method Summary
 Object computeGroupByKey(IMarker marker)
          Deprecated. Computes and returns key by which the given marker is grouped.
 

Method Detail

computeGroupByKey

public Object computeGroupByKey(IMarker marker)
Deprecated. 
Computes and returns key by which the given marker is grouped.

Parameters:
marker - the marker for which the key must be computed
Returns:
an object that will be used as the key for that marker, null if the marker seems to be invalid

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.