org.nuxeo.ecm.core.search.api.internals
Interface SearchServiceInternals

All Superinterfaces:

SearchService, java.io.Serializable

All Known Implementing Classes:

SearchServiceImpl

public interface SearchServiceInternals
extends SearchService

Search service internal API.

This API is not exposed publicly by the service.

Author:

Julien Anguenot

Method Summary

java.lang.String	getDefaultSearchEngineBakendName() Returns the default backend.
java.util.Set<java.lang.String>	getDocumentTypeNamesExtending(java.lang.String docType) Return the names of core document types extending the given one, which is included.
java.util.Set<java.lang.String>	getDocumentTypeNamesForFacet(java.util.Collection<java.lang.String> facets) Returns the set of document types bearing one of given facets.
java.util.Set<java.lang.String>	getDocumentTypeNamesForFacet(java.lang.String facet) Returns the set of document types bearing a given facet.
IndexableResourceDataConf	getIndexableDataConfByName(java.lang.String name) Returns the indexing data conf by its name.
IndexableResourceDataConf	getIndexableDataConfFor(java.lang.String dataName) Returns the indexing data conf for a given data name.
java.util.Map<java.lang.String,IndexableDocType>	getIndexableDocTypes() Returns a map from doc type to indexable doc types.
java.lang.String	getPreferedBackendNameFor(ResolvedResource resource) Returns the prefered backend for an indexable resolved resource.
SearchEngineBackend	getSearchEngineBackendByName(java.lang.String name) Returns a search engine plugin given its name.
java.util.Map<java.lang.String,SearchEngineBackend>	getSearchEngineBackends() Returns registred search engine plugins.
void	setDefaultSearchEngineBackendName(java.lang.String backendName) Sets the default backend given its name.

Methods inherited from interface org.nuxeo.ecm.core.search.api.client.SearchService

clear, closeSession, deleteAggregatedResources, deleteAtomicResource, getActiveIndexingTasks, getAvailableBackendNames, getBlobExtractorByName, getFullTextDescriptorByName, getIndexableDocTypeFor, getIndexableResourceConfByName, getIndexableResourceConfByPrefix, getIndexableResourceConfs, getIndexingDocBatchSize, getIndexingEventConfByName, getIndexingWaitingQueueSize, getNumberOfIndexingThreads, getResourceTypeDescriptorByName, getSearchPrincipal, getSupportedAnalyzersFor, getSupportedFieldTypes, getTotalCompletedIndexingTasks, index, index, invalidateComputedIndexableResourceConfs, isEnabled, isReindexingAll, openSession, reindexAll, saveAllSessions, searchQuery, searchQuery, searchQuery, setIndexingDocBatchSize, setNumberOfIndexingThreads, setReindexingAll, setStatus, unindex

Method Detail

getSearchEngineBackends

java.util.Map<java.lang.String,SearchEngineBackend> getSearchEngineBackends()

Returns registred search engine plugins.

Returns:

registred search engine plugins.

getSearchEngineBackendByName

SearchEngineBackend getSearchEngineBackendByName(java.lang.String name)

Returns a search engine plugin given its name.

Parameters:

name - : name of the search engine plugin.

Returns:

a search engine backend instance

getDefaultSearchEngineBakendName

java.lang.String getDefaultSearchEngineBakendName()

Returns the default backend.

It will be used as a fallback when no prefered backend are specified by a given resource.

Note, this is the backend responsability to register itself as default. And as well, the default backend can be overriden by another contributed backend. In this case, one can use the deployment order offered by Nuxeo runtime to ensure priority.

Returns null if no default backend registered.

Returns:

a search engine backend instance

setDefaultSearchEngineBackendName

void setDefaultSearchEngineBackendName(java.lang.String backendName)

Sets the default backend given its name.

Parameters:

backendName - a search engine backend instance.

getPreferedBackendNameFor

java.lang.String getPreferedBackendNameFor(ResolvedResource resource)

Returns the prefered backend for an indexable resolved resource.

Parameters:

resource - an indexable resolved resource.

Returns:

a backend name.

getIndexableDocTypes

java.util.Map<java.lang.String,IndexableDocType> getIndexableDocTypes()

Returns a map from doc type to indexable doc types.

Returns:

a map from doc type to indexable doc type.

getDocumentTypeNamesForFacet

java.util.Set<java.lang.String> getDocumentTypeNamesForFacet(java.lang.String facet)

Returns the set of document types bearing a given facet.

Parameters:

facet - the given facet

Returns:

the set of names, guaranteed to be non empty, or null

getDocumentTypeNamesForFacet

java.util.Set<java.lang.String> getDocumentTypeNamesForFacet(java.util.Collection<java.lang.String> facets)

Returns the set of document types bearing one of given facets.

Parameters:

facets - the given facets, as a collection

Returns:

the set of names, guaranteed to be non empty, or null

getDocumentTypeNamesExtending

java.util.Set<java.lang.String> getDocumentTypeNamesExtending(java.lang.String docType)

Return the names of core document types extending the given one, which is included.

Parameters:

docType - the base document type.

Returns:

the names as a set or null

getIndexableDataConfFor

IndexableResourceDataConf getIndexableDataConfFor(java.lang.String dataName)

Returns the indexing data conf for a given data name.

For instance, a data name can be dc:title

Parameters:

dataName - the data name.

Returns:

an indexable resource data conf.

getIndexableDataConfByName

IndexableResourceDataConf getIndexableDataConfByName(java.lang.String name)

Returns the indexing data conf by its name.

TODO This is a temporary helper for the current flat data model To be rethought

For instance, the name can be Title while the data name is dublincore:title.

Parameters:

name - the data name.

Returns:

an indexable resource data conf.