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
 
 
convert(jsonData, searchParams)
 
createSearchParams(keyword, nameSearch, useRoot, advancedOptions)
Returns a query object for search.
 
 
 
 
 
 
 
search(searchParams, Callback, generateMeta)
Runs a search and displays the results under the given DOM node.
 
 
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
cancel()

convert(jsonData, searchParams)
Parameters:
jsonData
searchParams

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()

getFileClient()

getFileService()

getSearchLocation()

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

setChildrenLocationbyURL(locationURL)
Parameters:
locationURL

setLocationByMetaData(meta, useParentLocation)
Parameters:
meta
useParentLocation

setLocationbyURL(locationURL)
Parameters:
locationURL

setRootLocationbyURL(locationURL)
Parameters:
locationURL

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Jan 18 2017 12:15:12 GMT-0500 (EST)