KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > search > ui > IGroupByKeyComputer


1 /*******************************************************************************
2  * Copyright (c) 2000, 2005 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.search.ui;
12
13 import org.eclipse.core.resources.IMarker;
14
15 /**
16  * Computes the key by which the markers in the search result view
17  * are grouped.
18  *
19  * <p>
20  * Clients may implement this interface.
21  * </p>
22  *
23  * @deprecated Part of the old ('classic') search result view. Since 3.0 clients can create their own search result view pages (see {@link ISearchResultPage}), leaving it up to the page
24  * how to group search results.
25  */
26 public interface IGroupByKeyComputer {
27     
28     /**
29      * Computes and returns key by which the given marker is grouped.
30      *
31      * @param marker the marker for which the key must be computed
32      * @return an object that will be used as the key for that marker,
33      * <code>null</code> if the marker seems to be invalid
34      */
35     public Object JavaDoc computeGroupByKey(IMarker marker);
36 }
37
Popular Tags