Eclipse Platform
Release 3.7

org.eclipse.help.search
Class SearchProcessorInfo

java.lang.Object
  extended by org.eclipse.help.search.SearchProcessorInfo

public class SearchProcessorInfo
extends Object

This class is a storage container for search processing

Since:
3.6

Constructor Summary
SearchProcessorInfo()
           
 
Method Summary
 String[] getAlternateTerms()
          After AbstractSearchProcessor.preSearch(String) is called, this method can be used to return an array of alternative search terms a user may wish to consider.
 String getQuery()
          After AbstractSearchProcessor.preSearch(String) is called, this method can be used to change the search query used.
 void setAlternateTerms(String[] alternateTerms)
          Sets the alternate terms to be considered.
 void setQuery(String query)
          Sets the query to search with.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchProcessorInfo

public SearchProcessorInfo()
Method Detail

getQuery

public String getQuery()
After AbstractSearchProcessor.preSearch(String) is called, this method can be used to change the search query used.

Returns:
new search query String, or null for no change.

setQuery

public void setQuery(String query)
Sets the query to search with.

Parameters:
query -
See Also:
getQuery()

getAlternateTerms

public String[] getAlternateTerms()
After AbstractSearchProcessor.preSearch(String) is called, this method can be used to return an array of alternative search terms a user may wish to consider.

Returns:
String[] of alternate terms, or null for no alternate terms. An empty array has the same effect as returning null.

setAlternateTerms

public void setAlternateTerms(String[] alternateTerms)
Sets the alternate terms to be considered.

Parameters:
alternateTerms -
See Also:
getAlternateTerms()

Eclipse Platform
Release 3.7

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.