Class SuggesterGroupDescriptor
- java.lang.Object
-
- org.nuxeo.ecm.platform.suggestbox.service.descriptors.SuggesterGroupDescriptor
-
-
Constructor Summary
Constructors Constructor Description SuggesterGroupDescriptor()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
append(String suggesterName, String newSuggesterName, boolean before)
Unless a suggester namednewSuggesterName
already exists in the#suggesters
list, appends a newSuggesterGroupItemDescriptor
namednewSuggesterName
just before (ifbefore
is true) or after the suggester namedsuggesterName
in the#suggesters
list.protected boolean
appendAfter(String suggesterName, String newSuggesterName)
Unless a suggester namednewSuggesterName
already exists in the#suggesters
list, appends a newSuggesterGroupItemDescriptor
namednewSuggesterName
just after the suggester namedsuggesterName
in the#suggesters
list.protected boolean
appendBefore(String suggesterName, String newSuggesterName)
Unless a suggester namednewSuggesterName
already exists in the#suggesters
list, appends a newSuggesterGroupItemDescriptor
namednewSuggesterName
just before the suggester namedsuggesterName
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 namedsuggesterName
in the#suggesters
list, or -1 ifsuggesterName
is null or if this list does not contain the element.protected void
logExistingSuggesterName(String newSuggesterName)
Logs that the suggester namednewSuggesterName
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 namedsuggesterName
from the#suggesters
list.
-
-
-
Field Detail
-
name
protected String name
-
-
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 classObject
- Throws:
CloneNotSupportedException
-
remove
protected boolean remove(String suggesterName)
Removes the suggester namedsuggesterName
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 namedsuggesterName
in the#suggesters
list, or -1 ifsuggesterName
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 ifsuggesterName
is null or if this list does not contain the element
-
appendBefore
protected boolean appendBefore(String suggesterName, String newSuggesterName)
Unless a suggester namednewSuggesterName
already exists in the#suggesters
list, appends a newSuggesterGroupItemDescriptor
namednewSuggesterName
just before the suggester namedsuggesterName
in the#suggesters
list. If the suggester namedsuggesterName
does not exist, appends the new suggester at the beginning of the list.- Parameters:
suggesterName
- the suggester namenewSuggesterName
- 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 namednewSuggesterName
already exists in the#suggesters
list, appends a newSuggesterGroupItemDescriptor
namednewSuggesterName
just after the suggester namedsuggesterName
in the#suggesters
list. If the suggester namedsuggesterName
does not exist, appends the new suggester at the end of the list.- Parameters:
suggesterName
- the suggester namenewSuggesterName
- 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 namednewSuggesterName
already exists in the#suggesters
list, appends a newSuggesterGroupItemDescriptor
namednewSuggesterName
just before (ifbefore
is true) or after the suggester namedsuggesterName
in the#suggesters
list. If the suggester namedsuggesterName
does not exist, appends the new suggester at the beginning or the end of the list, depending onbefore
.- Parameters:
suggesterName
- the suggester namenewSuggesterName
- 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 namednewSuggesterName
already exists in the#suggesters
list and therefore won't be appended to it.- Parameters:
newSuggesterName
- the new suggester name
-
-