| org.sakaiproject.search.api.SearchService
All known Subclasses: org.sakaiproject.search.component.service.impl.SearchServiceImpl,
| SearchService | | public interface SearchService extends Diagnosable(Code) | | Provides a search interface
author:
ieb |
| EVENT_SEARCH_REF | | final public static String EVENT_SEARCH_REF(Code) | | |
| EVENT_TRIGGER_INDEX_RELOAD | | final public static String EVENT_TRIGGER_INDEX_RELOAD(Code) | | event to trigger a reload of the search index by query nodes
|
| EVENT_TRIGGER_SEARCH | | final public static String EVENT_TRIGGER_SEARCH(Code) | | event to trigger an update of the index sent from Search Service to index
builders
|
| FIELD_CONTAINER | | final public static String FIELD_CONTAINER(Code) | | Search Field the container of the entity
|
| FIELD_CONTENTS | | final public static String FIELD_CONTENTS(Code) | | Searhc Field (term vector, not full contents) The contents of the Entity
|
| FIELD_CONTEXT | | final public static String FIELD_CONTEXT(Code) | | Search Field The context of the Entity
|
| FIELD_ID | | final public static String FIELD_ID(Code) | | Search Field The Sakai id of the entity
|
| FIELD_REFERENCE | | final public static String FIELD_REFERENCE(Code) | | Search field The reference of the entity
|
| FIELD_SITEID | | final public static String FIELD_SITEID(Code) | | Search Index Field the site id of the entity ( where is was produced)
|
| FIELD_SUBTYPE | | final public static String FIELD_SUBTYPE(Code) | | Search Field The tool subtype of the entity
|
| FIELD_TITLE | | final public static String FIELD_TITLE(Code) | | Seadch Field The title of the entity
|
| FIELD_TOOL | | final public static String FIELD_TOOL(Code) | | Search Field The Name of the Tool that owns the entity
|
| FIELD_TYPE | | final public static String FIELD_TYPE(Code) | | Search Field The tool type of the entity
|
| FIELD_URL | | final public static String FIELD_URL(Code) | | Search Index Field the url to the entity
|
| forceReload | | void forceReload()(Code) | | Force a reload regardless of if the index has changed
|
| getAllSearchItems | | List getAllSearchItems()(Code) | | get all the search items in the index (must be a lazy load list)
|
| getGlobalMasterSearchItems | | List getGlobalMasterSearchItems()(Code) | | get the global master items
|
| getNDocs | | int getNDocs()(Code) | | get the number of documents in the search index
|
| getPendingDocs | | int getPendingDocs()(Code) | | get the number of pending documents in the search index
|
| getSiteMasterSearchItems | | List getSiteMasterSearchItems()(Code) | | get the master itemf to sthe site
|
| getStatus | | String getStatus()(Code) | | get the status of the search service
|
| rebuildInstance | | void rebuildInstance()(Code) | | trigger a rebuild of the whole index
|
| rebuildSite | | void rebuildSite(String currentSiteId)(Code) | | rebuild the current site only
Parameters:
currentSiteId - |
| refreshInstance | | void refreshInstance()(Code) | | Trigger an refresh of the whole index
|
| refreshSite | | void refreshSite(String currentSiteId)(Code) | | Refresh the current site only
Parameters:
currentSiteId - |
| registerFunction | | void registerFunction(String function)(Code) | | Adds a function for the SearchService to respond to and route to the
index builder. EntityProducers that want their content to be searched,
should register the events that indicate new data to this
Parameters:
function - |
| reload | | void reload()(Code) | | When reload is called, the index should be reloaded
|
| removeWorkerLock | | boolean removeWorkerLock()(Code) | | force the removal of the worker lock
|
| search | | SearchList search(String searchTerms, List contexts, int searchStart, int searchEnd)(Code) | | Perform a search, return results in a list.
Parameters:
searchTerms - the search terms
Parameters:
contexts - a list of contexts in which to perform the search
Parameters:
searchEnd -
Parameters:
searchStart - |
| search | | public SearchList search(String searchTerms, List contexts, int start, int end, String filterName, String sorterName)(Code) | | This is the same as standard search, but the caller can specify, by name, the
index Filter and the index Sorter by name
The Sorter and the Filter will be consulted during the search, and hence should not
make massive demands on the framework, otherwise they will cripple the search
performance
Parameters:
searchTerms - A search string
Parameters:
contexts - A list of contexts
Parameters:
start - starting from
Parameters:
end - ending at
Parameters:
filterName - a lucene filter
Parameters:
sorterName - a lucene sorter |
| searchXML | | String searchXML(Map parameterMap)(Code) | | generates a block of XML representign the search results
Parameters:
parameterMap - |
|
|