org.nuxeo.ecm.core.search.api.backend.impl
Class AbstractSearchEngineBackend

java.lang.Object
  org.nuxeo.runtime.model.DefaultComponent
      org.nuxeo.ecm.core.search.api.backend.impl.AbstractSearchEngineBackend

All Implemented Interfaces:

java.io.Serializable, SearchEngineBackend, Adaptable, Component, Extensible

Direct Known Subclasses:

CoreSearchBackend

public abstract class AbstractSearchEngineBackend
extends DefaultComponent
implements SearchEngineBackend

Abstract search engine backend.

Third party code that whish to register a backend must extend this abc.

Author:

Julien Anguenot

See Also:

SearchEngineBackend, Serialized Form

Method Summary

java.lang.String	getConfigurationFileName() Get configuration file name if any.
java.lang.String	getName() Returns the plugin name.
java.util.List<java.lang.String>	getSupportedAnalyzersFor() Returns the supported analyers.
java.util.List<java.lang.String>	getSupportedFieldTypes() Returns the supported field types.
void	registerContribution(java.lang.Object contribution, java.lang.String extensionPoint, ComponentInstance contributor)
void	setConfigurationFileName(java.lang.String configurationFileName) Set the configuration filr name for this backend.
void	setName(java.lang.String name) Set the name of the plugin.

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, deactivate, getAdapter, registerExtension, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nuxeo.ecm.core.search.api.backend.SearchEngineBackend

clear, closeSession, createSession, deleteAggregatedResources, deleteAtomicResource, index, saveAllSessions, searchQuery, searchQuery, searchQuery

Method Detail

getName

public java.lang.String getName()

Description copied from interface: SearchEngineBackend

Returns the plugin name.

Specified by:

getName in interface SearchEngineBackend

setName

public void setName(java.lang.String name)

Description copied from interface: SearchEngineBackend

Set the name of the plugin.

Specified by:

setName in interface SearchEngineBackend

Parameters:

name - : the name of the plugin.

getSupportedAnalyzersFor

public java.util.List<java.lang.String> getSupportedAnalyzersFor()

Description copied from interface: SearchEngineBackend

Returns the supported analyers.

Specified by:

getSupportedAnalyzersFor in interface SearchEngineBackend

Returns:

a list of identifiers.

getSupportedFieldTypes

public java.util.List<java.lang.String> getSupportedFieldTypes()

Description copied from interface: SearchEngineBackend

Returns the supported field types.

Specified by:

getSupportedFieldTypes in interface SearchEngineBackend

Returns:

a list of identifiers.

getConfigurationFileName

public java.lang.String getConfigurationFileName()

Description copied from interface: SearchEngineBackend

Get configuration file name if any.

Expected to be loadable in the classpath.

This aimed at being optional. See backend descriptor in core.

Specified by:

getConfigurationFileName in interface SearchEngineBackend

Returns:

the configuration file name.

setConfigurationFileName

public void setConfigurationFileName(java.lang.String configurationFileName)

Description copied from interface: SearchEngineBackend

Set the configuration filr name for this backend.

This aimed at being optional. See backend descriptor in core.

Specified by:

setConfigurationFileName in interface SearchEngineBackend

Parameters:

configurationFileName - : the name of the configuration file with extension.

registerContribution

public void registerContribution(java.lang.Object contribution,
                                 java.lang.String extensionPoint,
                                 ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent