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

Class SuggesterDescriptor

java.lang.Object

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

All Implemented Interfaces:

Descriptor

public class SuggesterDescriptor
extends Object
implements Descriptor

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 ComponentInstance	contributingComponent
protected boolean	enabled
protected String	name
protected Map<String,String>	parameters

Fields inherited from interface org.nuxeo.runtime.model.Descriptor

UNIQUE_DESCRIPTOR_ID

Constructor Summary

Constructors

Constructor	Description
SuggesterDescriptor()

Method Summary

Modifier and Type	Method	Description
ComponentInstance	getContributingComponent()
String	getId()	The descriptor id, descriptors with same id are merged.
String	getName()
Map<String,String>	getParameters()
Suggester	instantiateSuggester()
boolean	isEnabled()
Descriptor	merge(Descriptor o)	Returns a descriptor representing other merged into this

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Descriptor

doesRemove

Field Details

name

protected String name

className

protected String className

enabled

protected boolean enabled

parameters

protected Map<String,String> parameters

contributingComponent

protected ComponentInstance contributingComponent

Constructor Details

SuggesterDescriptor

public SuggesterDescriptor()

Method Details

getId

public String getId()

Description copied from interface: Descriptor

The descriptor id, descriptors with same id are merged.

To forbid multiple descriptors use UNIQUE_DESCRIPTOR_ID.

To forbid merge use a unique value, non-overriden toString() for exemple.

Specified by:

getId in interface Descriptor

getName

public String getName()

isEnabled

public boolean isEnabled()

getParameters

public Map<String,String> getParameters()

getContributingComponent

public ComponentInstance getContributingComponent()

merge

public Descriptor merge(Descriptor o)

Description copied from interface: Descriptor

Returns a descriptor representing other merged into this

Default implementation returns other.

Specified by:

merge in interface Descriptor

Returns:

the merged descriptor

instantiateSuggester

public Suggester instantiateSuggester()