com.jalios.jcms
Class Category.NameSelector

java.lang.Object
  com.jalios.jcms.Category.NameSelector

All Implemented Interfaces:

DataSelector

Enclosing class:

Category

public static class Category.NameSelector
extends Object
implements DataSelector

Select categories by their name.

This selector can also be used to select category through their synonyms by using constructor Category.NameSelector(String, String, boolean) with second argument set to true.

Since:

jcms-5.7

Field Summary

protected String	lang
protected boolean	searchInSynonyms
protected String	text

Fields inherited from interface com.jalios.jcms.DataSelector

REVISION

Constructor Summary

Category.NameSelector(String text)
Builds a new NameSelector to select categories matching the specified text.

Category.NameSelector(String text, String lang)
Builds a new NameSelector to select categories matching the specified text in the specified language.

Category.NameSelector(String text, String lang, boolean searchInSynonyms)
Builds a new NameSelector to select categories matching the specified text in the specified language.

Method Summary

boolean

isSelected(Data data) Evaluates if a data must be selected or not.

Methods inherited from class java.lang.Object

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

Field Detail

text

protected String text

lang

protected String lang

searchInSynonyms

protected boolean searchInSynonyms

Constructor Detail

Category.NameSelector

public Category.NameSelector(String text)

Builds a new NameSelector to select categories matching the specified text.

Selection is performed against the name of the category in the default site language, without searching in synonyms.

Parameters:

text - the text to search, if null or empty, no category will be selected

Category.NameSelector

public Category.NameSelector(String text,
                             String lang)

Builds a new NameSelector to select categories matching the specified text in the specified language.

Selection is performed without searching in synonyms.

Parameters:

text - the text to search, if null or empty, no category will be selected

lang - the language of the Category's name in which the text should be checked, if null or empty, the default site language is used

Category.NameSelector

public Category.NameSelector(String text,
                             String lang,
                             boolean searchInSynonyms)

Builds a new NameSelector to select categories matching the specified text in the specified language.

Parameters:

text - the text to search, if null or empty, no category will be selected

lang - the language of the Category's name in which the text should be checked if null or empty, the default site language is used

searchInSynonyms - set to true to also perform text selection in synonyms

Since:

jcms-7.1.3 jcms-8.0.2 JCMS-3337

Method Detail

isSelected

public boolean isSelected(Data data)

Description copied from interface: DataSelector

Evaluates if a data must be selected or not.

Specified by:

isSelected in interface DataSelector

Parameters:

data - the data to evaluate.

Returns:

true if the data is selected. False otherwise.