Class Index | File Index

Classes


Class orion.searchClient.Searcher

Provides API for searching the workspace.
Defined in: </shared/eclipse/e4/orion/I201202282230/plugins/org.eclipse.orion.client.core/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
 
createSearchQuery(searchLocation, query, nameQuery, sort, skipLocation)
Returns a query URL for a search.
 
handleError(response, resultsNode)
 
search(query, excludeFile, Callback)
Runs a search and displays the results under the given DOM node.
 
setLocationByMetaData(meta, useParentLocation)
 
setLocationByURL(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
createSearchQuery(searchLocation, query, nameQuery, sort, skipLocation)
Returns a query URL for a search.
Parameters:
{String} searchLocation
The base location of the search service
{String} query
The text to search for, or null when searching purely on file name
{String} nameQuery Optional
The name of a file to search for
{String} sort Optional
The field to sort search results on. By default results will sort by path
{Boolean} skipLocation Optional
If true, do not use the location property of the searcher. Use "" as the location instead.

handleError(response, resultsNode)
Parameters:
response
resultsNode

search(query, excludeFile, Callback)
Runs a search and displays the results under the given DOM node.
Parameters:
{String} query
URI of the query to run.
{String} excludeFile Optional
URI of a file to exclude from the result listing.
{Function(JSONObject)} Callback
function that receives the results of the query.

setLocationByMetaData(meta, useParentLocation)
Parameters:
meta
useParentLocation

setLocationByURL(locationURL)
Parameters:
locationURL

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Feb 28 2012 22:34:47 GMT-0500 (EST)