- getAction(Event) - Method in interface org.sakaiproject.search.api.EntityContentProducer
-
Get the search builder action associated with the event.
- getAllSearchItems() - Method in interface org.sakaiproject.search.api.SearchIndexBuilder
-
get a list of all entitied in the search index
- getAllSearchItems() - Method in interface org.sakaiproject.search.api.SearchService
-
get all the search items in the index (must be a lazy load list)
- getCleanStringXX(String) - Static method in class org.sakaiproject.search.api.SearchUtils
-
- getContainer(String) - Method in interface org.sakaiproject.search.api.EntityContentProducer
-
- getContent(String) - Method in interface org.sakaiproject.search.api.EntityContentProducer
-
Get the content as a string
- getContentProducers() - Method in interface org.sakaiproject.search.api.SearchIndexBuilder
-
Get all the producers registered, as a clone to avoid concurrent
modification exceptions
- getContentReader(String) - Method in interface org.sakaiproject.search.api.EntityContentProducer
-
Get a reader for the supplied content resource
- getContext() - Method in interface org.sakaiproject.search.model.SearchBuilderItem
-
The context of the index item
- getCurrentDocument() - Method in interface org.sakaiproject.search.api.SearchIndexBuilderWorker
-
- getCurrentElapsed() - Method in interface org.sakaiproject.search.api.SearchIndexBuilderWorker
-
- getCurrentWorker() - Method in interface org.sakaiproject.search.api.SearchStatus
-
the current operational worker performing an index, none if there is none
actively indexing
- getCurrentWorkerETC() - Method in interface org.sakaiproject.search.api.SearchStatus
-
The latest expected time of completion of the current worker
- getCustomProperties(String) - Method in interface org.sakaiproject.search.api.EntityContentProducer
-
Gets a map of custom document properties.
- getCustomRDF(String) - Method in interface org.sakaiproject.search.api.EntityContentProducer
-
At the moment this is a placeholder, but eventually
It will return a block of Custom RDF, that the EntityContentProducer wants
the search index to index.
- getDigestStoragePath() - Method in interface org.sakaiproject.search.api.SearchService
-
Get the storage location for Digested content.
- getFieldNames() - Method in interface org.sakaiproject.search.api.SearchResult
-
All field names in the search record
- getFrequencies() - Method in interface org.sakaiproject.search.api.TermFrequency
-
get the frequencies
- getFullSize() - Method in interface org.sakaiproject.search.api.SearchList
-
- getGlobalMasterSearchItems() - Method in interface org.sakaiproject.search.api.SearchIndexBuilder
-
get a list of global search items
- getGlobalMasterSearchItems() - Method in interface org.sakaiproject.search.api.SearchService
-
get the global master items
- getId(String) - Method in interface org.sakaiproject.search.api.EntityContentProducer
-
- getId() - Method in interface org.sakaiproject.search.api.SearchResult
-
The result ID (entity id)
- getId() - Method in interface org.sakaiproject.search.model.SearchBuilderItem
-
- getIndex() - Method in interface org.sakaiproject.search.api.SearchResult
-
get the index of the search entry over the whole change set
- getIndexBuilderNames() - Method in interface org.sakaiproject.search.api.SearchService
-
- getItemscope() - Method in interface org.sakaiproject.search.model.SearchBuilderItem
-
- getLastDocument() - Method in interface org.sakaiproject.search.api.SearchIndexBuilderWorker
-
- getLastElapsed() - Method in interface org.sakaiproject.search.api.SearchIndexBuilderWorker
-
- getLastEventTime() - Method in interface org.sakaiproject.search.api.SearchIndexBuilderWorker
-
Get the ms time of the last search add/remove event (excluding master events)
- getLastIndex() - Method in interface org.sakaiproject.search.api.SearchIndexBuilderWorker
-
- getLastLoad() - Method in interface org.sakaiproject.search.api.SearchStatus
-
Last time the index was loaded
- getLoadTime() - Method in interface org.sakaiproject.search.api.SearchStatus
-
How long it tool to load the index
- getLock() - Method in interface org.sakaiproject.search.model.SearchBuilderItem
-
The lock id on this object
- getLockTransaction(long) - Method in interface org.sakaiproject.search.api.SearchIndexBuilderWorker
-
- getLockTransaction(long, boolean) - Method in interface org.sakaiproject.search.api.SearchIndexBuilderWorker
-
- getName() - Method in interface org.sakaiproject.search.api.SearchIndexBuilder
-
Access the logical, well-known name of this index builder.
- getName() - Method in interface org.sakaiproject.search.model.SearchBuilderItem
-
Name of the resource in the search index
- getNDocs() - Method in interface org.sakaiproject.search.api.SearchService
-
get the number of documents in the search index
- getNDocuments() - Method in interface org.sakaiproject.search.api.SearchStatus
-
the number of documents in the index, including those marked as deleted
- getNowIndexing() - Method in interface org.sakaiproject.search.api.SearchIndexBuilderWorker
-
- getPDocuments() - Method in interface org.sakaiproject.search.api.SearchStatus
-
get the number of documents pending to be indexed, including master
items.
- getPendingDocs() - Method in interface org.sakaiproject.search.api.SearchService
-
get the number of pending documents in the search index
- getPendingDocuments() - Method in interface org.sakaiproject.search.api.SearchIndexBuilder
-
get the number of pending documents
- getReference() - Method in interface org.sakaiproject.search.api.SearchResult
-
get the Sakai Entity Reference String
- getScore() - Method in interface org.sakaiproject.search.api.SearchResult
-
the result score
- getSearchaction() - Method in interface org.sakaiproject.search.model.SearchBuilderItem
-
The action being performed
- getSearchResult() - Method in interface org.sakaiproject.search.api.SearchResult
-
get the search result content for display
- getSearchstate() - Method in interface org.sakaiproject.search.model.SearchBuilderItem
-
The state of the record
- getSearchStatus() - Method in interface org.sakaiproject.search.api.SearchService
-
Get the status of the search engine
- getSearchSuggestion(String) - Method in interface org.sakaiproject.search.api.SearchService
-
Get a suggestion for spelling errors etc
- getSearchSuggestions(String, String, boolean) - Method in interface org.sakaiproject.search.api.SearchService
-
- getSearchSuggestions(String, String, boolean, String) - Method in interface org.sakaiproject.search.api.SearchService
-
- getSegmentInfo() - Method in interface org.sakaiproject.search.api.SearchService
-
- getSiteContentIterator(String) - Method in interface org.sakaiproject.search.api.EntityContentProducer
-
Get the site content as an iterator
- getSiteId(String) - Method in interface org.sakaiproject.search.api.EntityContentProducer
-
get the site ID from the resource Name
- getSiteId() - Method in interface org.sakaiproject.search.api.SearchResult
-
- getSiteMasterSearchItems() - Method in interface org.sakaiproject.search.api.SearchService
-
get the master itemf to sthe site
- getSiteMasterSearchItems() - Method in interface org.sakaiproject.search.api.SiteSearchIndexBuilder
-
get a list of Master Search Items that control the search operation for the
Site (current site)
- getStart() - Method in interface org.sakaiproject.search.api.SearchList
-
- getStartDocIndex() - Method in interface org.sakaiproject.search.api.SearchIndexBuilderWorker
-
- getStatus() - Method in interface org.sakaiproject.search.api.SearchService
-
get the status of the search service
- getSubType(String) - Method in interface org.sakaiproject.search.api.EntityContentProducer
-
- getTerms() - Method in interface org.sakaiproject.search.api.SearchResult
-
gets the term frequencies for this Document
- getTerms(int) - Method in interface org.sakaiproject.search.api.SearchService
-
get the term vector for this document, where document is the
- getTerms() - Method in interface org.sakaiproject.search.api.TermFrequency
-
get the terms, ordered by frequency
- getTitle(String) - Method in interface org.sakaiproject.search.api.EntityContentProducer
-
get the title for the content
- getTitle() - Method in interface org.sakaiproject.search.api.SearchResult
-
The title of the resource, usually including the type (eg Wiki Page,
Resource)
- getTool() - Method in interface org.sakaiproject.search.api.EntityContentProducer
-
What is the name of the tool,
- getTool() - Method in interface org.sakaiproject.search.api.SearchResult
-
get the tool name that this search cam from
- getTriggerFunctions() - Method in interface org.sakaiproject.search.api.EntityContentProducerEvents
-
- getType(String) - Method in interface org.sakaiproject.search.api.EntityContentProducer
-
- getUrl(String) - Method in interface org.sakaiproject.search.api.EntityContentProducer
-
Gets the url that displays the entity
- getUrl() - Method in interface org.sakaiproject.search.api.SearchResult
-
An absolute URL to the resource (no host, protocol or port)
- getValueMap() - Method in interface org.sakaiproject.search.api.SearchResult
-
Get a map of values in the result
- getValues(String) - Method in interface org.sakaiproject.search.api.SearchResult
-
All values in a search field
- getVersion() - Method in interface org.sakaiproject.search.model.SearchBuilderItem
-
The last update to the record
- getWorkerNodes() - Method in interface org.sakaiproject.search.api.SearchStatus
-
A list of all worker nodes in the cluster
- GLOBAL_CONTEXT - Static variable in interface org.sakaiproject.search.model.SearchBuilderItem
-
- GLOBAL_MASTER - Static variable in interface org.sakaiproject.search.model.SearchBuilderItem
-
- RDFException - Exception in org.sakaiproject.search.api.rdf
-
- RDFException() - Constructor for exception org.sakaiproject.search.api.rdf.RDFException
-
- RDFException(String) - Constructor for exception org.sakaiproject.search.api.rdf.RDFException
-
- RDFException(String, Throwable) - Constructor for exception org.sakaiproject.search.api.rdf.RDFException
-
- RDFException(Throwable) - Constructor for exception org.sakaiproject.search.api.rdf.RDFException
-
- RDFIndexException - Exception in org.sakaiproject.search.api.rdf
-
- RDFIndexException() - Constructor for exception org.sakaiproject.search.api.rdf.RDFIndexException
-
- RDFIndexException(String, Throwable) - Constructor for exception org.sakaiproject.search.api.rdf.RDFIndexException
-
- RDFIndexException(String) - Constructor for exception org.sakaiproject.search.api.rdf.RDFIndexException
-
- RDFIndexException(Throwable) - Constructor for exception org.sakaiproject.search.api.rdf.RDFIndexException
-
- RDFSearchException - Exception in org.sakaiproject.search.api.rdf
-
- RDFSearchException() - Constructor for exception org.sakaiproject.search.api.rdf.RDFSearchException
-
- RDFSearchException(String) - Constructor for exception org.sakaiproject.search.api.rdf.RDFSearchException
-
- RDFSearchException(String, Throwable) - Constructor for exception org.sakaiproject.search.api.rdf.RDFSearchException
-
- RDFSearchException(Throwable) - Constructor for exception org.sakaiproject.search.api.rdf.RDFSearchException
-
- RDFSearchService - Interface in org.sakaiproject.search.api.rdf
-
- rebuildIndex() - Method in interface org.sakaiproject.search.api.SearchIndexBuilder
-
rebuild the index completely from scratch
- rebuildIndex(String) - Method in interface org.sakaiproject.search.api.SearchService
-
Trigger a rebuild of the named index
- rebuildIndex(String) - Method in interface org.sakaiproject.search.api.SiteSearchIndexBuilder
-
Rebuild the index for the supplied siteId
- rebuildInstance() - Method in interface org.sakaiproject.search.api.SearchService
-
trigger a rebuild of the whole index
- rebuildSite(String) - Method in interface org.sakaiproject.search.api.SearchService
-
rebuild the current site only
- refreshIndex() - Method in interface org.sakaiproject.search.api.SearchIndexBuilder
-
Refresh the index based on the registered entities
- refreshIndex(String) - Method in interface org.sakaiproject.search.api.SearchService
-
Trigger a refresh of the named index
- refreshIndex(String) - Method in interface org.sakaiproject.search.api.SiteSearchIndexBuilder
-
Refresh the index for the supplied siteId
- refreshInstance() - Method in interface org.sakaiproject.search.api.SearchService
-
Trigger an refresh of the whole index
- refreshSite(String) - Method in interface org.sakaiproject.search.api.SearchService
-
Refresh the current site only
- registerEntityContentProducer(EntityContentProducer) - Method in interface org.sakaiproject.search.api.SearchIndexBuilder
-
Register an implementation-specific indexable content producer instance with this
SearchIndexBuilder.
- registerFunction(String) - Method in interface org.sakaiproject.search.api.SearchService
-
Adds a function for the SearchService to respond to and route to the
index builder.
- reload() - Method in interface org.sakaiproject.search.api.SearchService
-
When reload is called, the index should be reloaded
- removeWorkerLock() - Method in interface org.sakaiproject.search.api.SearchIndexBuilderWorker
-
forge the removal of the worker lock
- removeWorkerLock() - Method in interface org.sakaiproject.search.api.SearchService
-
force the removal of the worker lock
- REST_CHECKSUM - Static variable in interface org.sakaiproject.search.api.SearchService
-
- REST_CONTEXTS - Static variable in interface org.sakaiproject.search.api.SearchService
-
- REST_END - Static variable in interface org.sakaiproject.search.api.SearchService
-
- REST_START - Static variable in interface org.sakaiproject.search.api.SearchService
-
- REST_TERMS - Static variable in interface org.sakaiproject.search.api.SearchService
-
- REST_USERID - Static variable in interface org.sakaiproject.search.api.SearchService
-
- scope - Static variable in interface org.sakaiproject.search.model.SearchBuilderItem
-
- search(String) - Method in interface org.sakaiproject.search.api.rdf.RDFSearchService
-
Performs a table based search using RQL on the RDF store returning a list of results.
- search(String, List<String>, int, int) - Method in interface org.sakaiproject.search.api.SearchService
-
Perform a search, return results in a list.
- search(String, List<String>, int, int, String, String) - Method in interface org.sakaiproject.search.api.SearchService
-
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
- search(String, List<String>, int, int, String) - Method in interface org.sakaiproject.search.api.SearchService
-
This is the same as standard search, but the caller can specify the logical name
of the index builder which should execute the search.
- search(String, List<String>, int, int, String, Map<String, String>) - Method in interface org.sakaiproject.search.api.SearchService
-
This is the same as standard search, but the caller can specify the logical name
of the index builder which should execute the search and pass a more complex information in the search Terms.
- SearchBuilderItem - Interface in org.sakaiproject.search.model
-
Represents an operation or state of a document in the search engine.
- SearchIndexBuilder - Interface in org.sakaiproject.search.api
-
A SearchIndexBuilder builds a search index, it must manage its own list of
pending documents and should probably do this in a separate thread
- SearchIndexBuilderWorker - Interface in org.sakaiproject.search.api
-
- SearchList - Interface in org.sakaiproject.search.api
-
- searchResponse(String, List<String>, int, int, String, Map<String, String>) - Method in interface org.sakaiproject.search.api.SearchService
-
This is the same as standard search, but the caller can specify the logical name
of the index builder which should execute the search and pass a more complex information in the search Terms.
- SearchResult - Interface in org.sakaiproject.search.api
-
- SearchService - Interface in org.sakaiproject.search.api
-
Provides a search interface
- SearchStatus - Interface in org.sakaiproject.search.api
-
A search status object
- SearchUtils - Class in org.sakaiproject.search.api
-
- SearchUtils() - Constructor for class org.sakaiproject.search.api.SearchUtils
-
- searchXML(Map) - Method in interface org.sakaiproject.search.api.SearchService
-
generates a block of XML representing the search results
- setContext(String) - Method in interface org.sakaiproject.search.model.SearchBuilderItem
-
The context of the index item
- setId(String) - Method in interface org.sakaiproject.search.model.SearchBuilderItem
-
- setItemscope(Integer) - Method in interface org.sakaiproject.search.model.SearchBuilderItem
-
- setLastIndex(long) - Method in interface org.sakaiproject.search.api.SearchIndexBuilderWorker
-
- setName(String) - Method in interface org.sakaiproject.search.model.SearchBuilderItem
-
The name of the resource in the search index
- setNowIndexing(String) - Method in interface org.sakaiproject.search.api.SearchIndexBuilderWorker
-
- setSearchaction(Integer) - Method in interface org.sakaiproject.search.model.SearchBuilderItem
-
The action being performed
- setSearchstate(Integer) - Method in interface org.sakaiproject.search.model.SearchBuilderItem
-
The state of the record
- setStartDocIndex(long) - Method in interface org.sakaiproject.search.api.SearchIndexBuilderWorker
-
- setUrl(String) - Method in interface org.sakaiproject.search.api.SearchResult
-
Set the Url - needed for tols that generate portal urls
- setVersion(Date) - Method in interface org.sakaiproject.search.model.SearchBuilderItem
-
The last update to the record
- SITE_MASTER_FORMAT - Static variable in interface org.sakaiproject.search.model.SearchBuilderItem
-
- SITE_MASTER_PATTERN - Static variable in interface org.sakaiproject.search.model.SearchBuilderItem
-
- SiteSearchIndexBuilder - Interface in org.sakaiproject.search.api
-
- STATE_COMPLETED - Static variable in interface org.sakaiproject.search.model.SearchBuilderItem
-
Operation completed
- STATE_FAILED - Static variable in interface org.sakaiproject.search.model.SearchBuilderItem
-
- STATE_LOCKED - Static variable in interface org.sakaiproject.search.model.SearchBuilderItem
-
Locked for processing
- STATE_PENDING - Static variable in interface org.sakaiproject.search.model.SearchBuilderItem
-
Operation pending
- STATE_PENDING_2 - Static variable in interface org.sakaiproject.search.model.SearchBuilderItem
-
- STATE_UNKNOWN - Static variable in interface org.sakaiproject.search.model.SearchBuilderItem
-
Unknown state
- states - Static variable in interface org.sakaiproject.search.model.SearchBuilderItem
-
- StoredDigestContentProducer - Interface in org.sakaiproject.search.api
-
A Zero method interface to implement if your producer wants the digested text stored.