Class orion.searchClient.Searcher
Provides API for searching the workspace.
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.ui/web/orion/searchClient.js>.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
orion.searchClient.Searcher(options)
Creates a new search client.
|
| Method Attributes | Method Name and Description |
|---|---|
|
createSearchParams(keyword, nameSearch, useRoot, advancedOptions)
Returns a query object for search.
|
|
|
handleError(response, resultsNode)
|
|
|
search(searchParams, folderKeyword, Callback)
Runs a search and displays the results under the given DOM node.
|
|
|
setChildrenLocationbyURL(locationURL)
|
|
|
setCrawler(crawler)
|
|
|
setLocationByMetaData(meta, useParentLocation)
|
|
|
setLocationbyURL(locationURL)
|
|
|
setRootLocationbyURL(locationURL)
|
Class Detail
orion.searchClient.Searcher(options)
Creates a new search client.
- Parameters:
- {Object} options
- The options object
- {orion.serviceregistry.ServiceRegistry} options.serviceRegistry
- The service registry
Method Detail
createSearchParams(keyword, nameSearch, useRoot, advancedOptions)
Returns a query object for search. The return value has the propertyies of resource and parameters.
- Parameters:
- {String} keyword
- The text to search for, or null when searching purely on file name
- {Boolean} nameSearch Optional
- The name of a file to search for
- {Boolean} useRoot Optional
- If true, do not use the location property of the searcher. Use the root url of the file system instead.
- advancedOptions
getChildrenLocation()
getFileService()
getSearchLocation()
getSearchRootLocation()
handleError(response, resultsNode)
- Parameters:
- response
- resultsNode
search(searchParams, folderKeyword, Callback)
Runs a search and displays the results under the given DOM node.
- Parameters:
- {Object} searchParams
- The search parameters.
- {String} folderKeyword Optional
- The filter to show only files whose path contains the folderKeyword.
- {Function(JSONObject)} Callback
- function that receives the results of the query.
setChildrenLocationbyURL(locationURL)
- Parameters:
- locationURL
setCrawler(crawler)
- Parameters:
- crawler
setLocationByMetaData(meta, useParentLocation)
- Parameters:
- meta
- useParentLocation
setLocationbyURL(locationURL)
- Parameters:
- locationURL
setRootLocationbyURL(locationURL)
- Parameters:
- locationURL