Eclipse Platform
2.0

org.eclipse.search.ui
Interface ISearchPageScoreComputer


public interface ISearchPageScoreComputer

Computes a score that is used by the search dialog to find the best fitting page for a selection when opened. The score has no upper limit but must be at least LOWEST. Higher values means the page is better suited for the given selection input.

For example, a Java-specific search page score computer could test if the page is a Java search page and returns high scores for Java elements as selection input.


Field Summary
static int LOWEST
          Lowest possible valid score.
static int UNKNOWN
          Invalid score value indicating a score is unknown or undecided.
 
Method Summary
 int computeScore(String pageId, Object input)
          Computes and returns a score indicating how good the page with the given id can handle the given input element.
 

Field Detail

UNKNOWN

public static final int UNKNOWN
Invalid score value indicating a score is unknown or undecided.

See Also:
Constant Field Values

LOWEST

public static final int LOWEST
Lowest possible valid score.

See Also:
Constant Field Values
Method Detail

computeScore

public int computeScore(String pageId,
                        Object input)
Computes and returns a score indicating how good the page with the given id can handle the given input element. The search page id appears as the id attribute of the <page> element contributed to the search pages extension point ("org.eclipse.search.searchPages").

Parameters:
pageId - the string id of the page for which the score is computed
input - the object based on which the page should open
Returns:
a score higher or equal to LOWEST, or UNKNOWN if this computer cannot decide

Eclipse Platform
2.0

Copyright (c) IBM Corp. and others 2000, 2002. All Rights Reserved.