Package org.nuxeo.ecm.platform.suggestbox.service.descriptors

Class SuggesterDescriptor

java.lang.Object

org.nuxeo.ecm.platform.suggestbox.service.descriptors.SuggesterDescriptor

All Implemented Interfaces:

Cloneable

public class SuggesterDescriptor
extends Object
implements Cloneable

XMap descriptor for registering overridable parameterized Suggester implementation on the SuggesterService.

Author:

ogrisel

Field Summary

Fields

Modifier and Type	Field	Description
protected String	className
protected boolean	enabled
protected String	name
protected Map<String,String>	parameters
protected RuntimeContext	runtimeContext
protected Suggester	suggester

Constructor Summary

Constructors

Constructor	Description
SuggesterDescriptor()

Method Summary

Modifier and Type	Method	Description
Object	clone()
String	getName()
Map<String,String>	getParameters()
Suggester	getSuggester()
boolean	isEnabled()
protected void	loadParameterizedSuggester()
void	mergeFrom(SuggesterDescriptor newDescriptor)
void	setRuntimeContext(RuntimeContext context)

Methods inherited from class java.lang.Object

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

Field Details

name

protected String name

className

protected String className

enabled

protected boolean enabled

parameters

protected Map<String,String> parameters

suggester

protected Suggester suggester

runtimeContext

protected RuntimeContext runtimeContext

Constructor Details

SuggesterDescriptor

public SuggesterDescriptor()

Method Details

getName

public String getName()

isEnabled

public boolean isEnabled()

getParameters

public Map<String,String> getParameters()

setRuntimeContext

public void setRuntimeContext(RuntimeContext context)
                       throws ComponentInitializationException

Throws:

ComponentInitializationException

loadParameterizedSuggester

protected void loadParameterizedSuggester()
                                   throws ComponentInitializationException

Throws:

ComponentInitializationException

getSuggester

public Suggester getSuggester()

mergeFrom

public void mergeFrom(SuggesterDescriptor newDescriptor)
               throws ComponentInitializationException

Throws:

ComponentInitializationException

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException