|
Eclipse Platform Release 3.7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.help.search.SearchProcessorInfo
public class SearchProcessorInfo
This class is a storage container for search processing
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 |
---|
public SearchProcessorInfo()
Method Detail |
---|
public String getQuery()
AbstractSearchProcessor.preSearch(String)
is called,
this method can be used to change the search query used.
null
for no change.public void setQuery(String query)
query
- getQuery()
public String[] getAlternateTerms()
AbstractSearchProcessor.preSearch(String)
is called,
this method can be used to return an array of alternative search terms
a user may wish to consider.
null
for no alternate terms.
An empty array has the same effect as returning null
.public void setAlternateTerms(String[] alternateTerms)
alternateTerms
- getAlternateTerms()
|
Eclipse Platform Release 3.7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.