Class Index | File Index

Classes


Class orion.searchClient.Searcher

Provides API for searching the workspace.
Defined in: </jobs/genie.orion/orion-client-stable/workspace/bundles/org.eclipse.orion.client.ui/web/orion/searchClient.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates a new search client.
Method Summary
Method Attributes Method Name and Description
 
addDisplaycallback(displayCallback, searchScopeOption)
 
convert(jsonData, searchParams)
 
createSearchParams(keyword, nameSearch, useRoot, advancedOptions, searchScope)
Returns a query object for search.
 
 
 
 
getSearchLocation(searchScope)
 
 
 
search(searchParams, Callback, generateMeta)
Runs a search and displays the results under the given DOM node.
 
setLocationByMetaData(meta, useParentLocation)
Used to update "selectd" and "project" search scope based on the file or folder selected.
 
setLocationbyURL(locationURL)
 
setLocationOther(otherLocation)
Used to update "other" search scope, this location info comes directly from InlineSearchPane.js
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
addDisplaycallback(displayCallback, searchScopeOption)
Parameters:
displayCallback
searchScopeOption

convert(jsonData, searchParams)
Parameters:
jsonData
searchParams

createSearchParams(keyword, nameSearch, useRoot, advancedOptions, searchScope)
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
searchScope

getChildrenLocation()

getFileClient()

getFileService()

getSearchLocation(searchScope)
Parameters:
searchScope

getSearchLocationName()

getSearchRootLocation()

search(searchParams, Callback, generateMeta)
Runs a search and displays the results under the given DOM node.
Parameters:
{Object} searchParams
The search parameters.
{Function(JSONObject)} Callback
function that receives the results of the query.
generateMeta

setLocationByMetaData(meta, useParentLocation)
Used to update "selectd" and "project" search scope based on the file or folder selected.
Parameters:
meta
useParentLocation

setLocationbyURL(locationURL)
Parameters:
locationURL

setLocationOther(otherLocation)
Used to update "other" search scope, this location info comes directly from InlineSearchPane.js
Parameters:
otherLocation

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Jun 29 2017 14:37:22 GMT-0400 (EDT)