Package org.eclipse.help.search
Class SearchProcessorInfo
- java.lang.Object
-
- org.eclipse.help.search.SearchProcessorInfo
-
public class SearchProcessorInfo extends Object
This class is a storage container for search processing- Since:
- 3.6
-
-
Constructor Summary
Constructors Constructor Description SearchProcessorInfo()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String[]
getAlternateTerms()
AfterAbstractSearchProcessor.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()
AfterAbstractSearchProcessor.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.
-
-
-
Method Detail
-
getQuery
public String getQuery()
AfterAbstractSearchProcessor.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
- the new search query string- See Also:
getQuery()
-
getAlternateTerms
public String[] getAlternateTerms()
AfterAbstractSearchProcessor.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 returningnull
.
-
setAlternateTerms
public void setAlternateTerms(String[] alternateTerms)
Sets the alternate terms to be considered.- Parameters:
alternateTerms
- new alternate search terms, ornull
for no alternate terms.- See Also:
getAlternateTerms()
-
-