Class Index | File Index

Classes


Class orion.searchClient.Searcher

Provides API for searching the workspace.
Defined in: </shared/eclipse/e4/orion/I201210191304/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(query, nameQuery, sort, useRoot, searchPrefix, forceRegEx)
Returns a query URL for a search.
 
 
 
 
 
handleError(response, resultsNode)
 
search(query, excludeFile, Callback, keyWordSearch)
Runs a search and displays the results under the given DOM node.
 
 
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
createSearchQuery(query, nameQuery, sort, useRoot, searchPrefix, forceRegEx)
Returns a query URL for a search.
Parameters:
{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} useRoot Optional
If true, do not use the location property of the searcher. Use the root url of the file system instead.
searchPrefix
forceRegEx

getChildrenLocation()

getFileService()

getSearchLocation()

getSearchRootLocation()

handleError(response, resultsNode)
Parameters:
response
resultsNode

search(query, excludeFile, Callback, keyWordSearch)
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.
{Boolean} keyWordSearch Optional
If true, do keyword search. Otherwise do name search.

setChildrenLocationbyURL(locationURL)
Parameters:
locationURL

setCrawler(crawler)
Parameters:
crawler

setLocationByMetaData(meta, useParentLocation)
Parameters:
meta
useParentLocation

setLocationbyURL(locationURL)
Parameters:
locationURL

setRootLocationbyURL(locationURL)
Parameters:
locationURL

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Oct 19 2012 13:08:15 GMT-0400 (EDT)