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

Class SuggesterGroupDescriptor

java.lang.Object

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

All Implemented Interfaces:

Cloneable

public class SuggesterGroupDescriptor
extends Object
implements Cloneable

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name

Constructor Summary

Constructors

Constructor and Description
SuggesterGroupDescriptor()

Method Summary

Modifier and Type	Method and Description
protected boolean	append(String suggesterName, String newSuggesterName, boolean before) Unless a suggester named newSuggesterName already exists in the #suggesters list, appends a new SuggesterGroupItemDescriptor named newSuggesterName just before (if before is true) or after the suggester named suggesterName in the #suggesters list.
protected boolean	appendAfter(String suggesterName, String newSuggesterName) Unless a suggester named newSuggesterName already exists in the #suggesters list, appends a new SuggesterGroupItemDescriptor named newSuggesterName just after the suggester named suggesterName in the #suggesters list.
protected boolean	appendBefore(String suggesterName, String newSuggesterName) Unless a suggester named newSuggesterName already exists in the #suggesters list, appends a new SuggesterGroupItemDescriptor named newSuggesterName just before the suggester named suggesterName in the #suggesters list.
Object	clone()
String	getName()
List<SuggesterGroupItemDescriptor>	getSuggesters()
protected int	indexOf(String suggesterName) Returns the index of the first occurrence of the element named suggesterName in the #suggesters list, or -1 if suggesterName is null or if this list does not contain the element.
protected void	logExistingSuggesterName(String newSuggesterName) Logs that the suggester named newSuggesterName already exists in the #suggesters list and therefore won't be appended to it.
void	mergeFrom(SuggesterGroupDescriptor newDescriptor)
protected boolean	remove(String suggesterName) Removes the suggester named suggesterName from the #suggesters list.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

Constructor Detail

SuggesterGroupDescriptor

public SuggesterGroupDescriptor()

Method Detail

getName

public String getName()

getSuggesters

public List<SuggesterGroupItemDescriptor> getSuggesters()

mergeFrom

public void mergeFrom(SuggesterGroupDescriptor newDescriptor)
               throws ComponentInitializationException

Throws:

ComponentInitializationException

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

remove

protected boolean remove(String suggesterName)

Removes the suggester named suggesterName from the #suggesters list.

Parameters:

suggesterName - the suggester name

Returns:

true, if a suggester was removed

indexOf

protected int indexOf(String suggesterName)

Returns the index of the first occurrence of the element named suggesterName in the #suggesters list, or -1 if suggesterName is null or if this list does not contain the element.

Parameters:

suggesterName - the suggester name

Returns:

the index of the first occurrence of the element named suggesterName in the #suggesters list, or -1 if suggesterName is null or if this list does not contain the element

appendBefore

protected boolean appendBefore(String suggesterName,
                               String newSuggesterName)

Unless a suggester named newSuggesterName already exists in the #suggesters list, appends a new SuggesterGroupItemDescriptor named newSuggesterName just before the suggester named suggesterName in the #suggesters list. If the suggester named suggesterName does not exist, appends the new suggester at the beginning of the list.

Parameters:

suggesterName - the suggester name

newSuggesterName - the name of the suggester to append

Returns:

true, if the suggester named newSuggesterName was appended to the #suggesters list

appendAfter

protected boolean appendAfter(String suggesterName,
                              String newSuggesterName)

Unless a suggester named newSuggesterName already exists in the #suggesters list, appends a new SuggesterGroupItemDescriptor named newSuggesterName just after the suggester named suggesterName in the #suggesters list. If the suggester named suggesterName does not exist, appends the new suggester at the end of the list.

Parameters:

suggesterName - the suggester name

newSuggesterName - the name of the suggester to append

Returns:

true, if the suggester named newSuggesterName was appended to the #suggesters list

append

protected boolean append(String suggesterName,
                         String newSuggesterName,
                         boolean before)

Unless a suggester named newSuggesterName already exists in the #suggesters list, appends a new SuggesterGroupItemDescriptor named newSuggesterName just before (if before is true) or after the suggester named suggesterName in the #suggesters list. If the suggester named suggesterName does not exist, appends the new suggester at the beginning or the end of the list, depending on before.

Parameters:

suggesterName - the suggester name

newSuggesterName - the name of the suggester to append

Returns:

true, if the suggester named newSuggesterName was appended to the #suggesters list

logExistingSuggesterName

protected void logExistingSuggesterName(String newSuggesterName)

Logs that the suggester named newSuggesterName already exists in the #suggesters list and therefore won't be appended to it.

Parameters:

newSuggesterName - the new suggester name