Package org.alfresco.repo.search
Enum MLAnalysisMode
- java.lang.Object
-
- java.lang.Enum<MLAnalysisMode>
-
- org.alfresco.repo.search.MLAnalysisMode
-
- All Implemented Interfaces:
Serializable
,Comparable<MLAnalysisMode>
public enum MLAnalysisMode extends Enum<MLAnalysisMode>
Enum to specify how multi-lingual properties should be treate for indexing and search. Note that locale new Locale ("", "", "") is used to indicate all locales.- Author:
- andyh
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ALL_COUNTRIES
All country matchesALL_COUNTRIES_AND_ALL
All countries and ALLALL_LANGUAGES
All language matches.ALL_LANGUAGES_AND_ALL
All language matches and ALLALL_ONLY
Just the all locale, "", === new Locale("", "", "")EXACT_COUNRTY
Exact country matches (do not include all sub varients of the country)EXACT_COUNTRY_AND_ALL
Exact country matches (do not include all sub varients of the country) and ALLEXACT_LANGUAGE
Exact language matches (do not include all sub varients of the language)EXACT_LANGUAGE_AND_ALL
Exact language matches (do not include all sub varients of the language) and ALLLOCALE_AND_ALL
Only the exact locale and no locale === locale + all languagesLOCALE_AND_ALL_CONTAINED_LOCALES
Expand to all the locales that are contained by this.LOCALE_AND_ALL_CONTAINING_LOCALES
Expand the locale to include all the locales that contain it.LOCALE_AND_ALL_CONTAINING_LOCALES_AND_ALL
Expand the locale to include all the locales that contain it.LOCALE_ONLY
Only the exact locale is used.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static Set<Locale>
getLocales(MLAnalysisMode mlAnalaysisMode, Locale locale, boolean withWildcards)
static MLAnalysisMode
getMLAnalysisMode(String mode)
abstract boolean
includesAll()
abstract boolean
includesAllCountryMatches()
abstract boolean
includesAllLanguageMatches()
abstract boolean
includesContained()
abstract boolean
includesContaining()
abstract boolean
includesExact()
abstract boolean
includesExactCountryMatch()
abstract boolean
includesExactLanguageMatch()
static MLAnalysisMode
valueOf(String name)
Returns the enum constant of this type with the specified name.static MLAnalysisMode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
LOCALE_ONLY
public static final MLAnalysisMode LOCALE_ONLY
Only the exact locale is used.
-
LOCALE_AND_ALL
public static final MLAnalysisMode LOCALE_AND_ALL
Only the exact locale and no locale === locale + all languages
-
LOCALE_AND_ALL_CONTAINING_LOCALES
public static final MLAnalysisMode LOCALE_AND_ALL_CONTAINING_LOCALES
Expand the locale to include all the locales that contain it. So "en_GB" would be "en_GB", "en", but not all languages "".
-
LOCALE_AND_ALL_CONTAINING_LOCALES_AND_ALL
public static final MLAnalysisMode LOCALE_AND_ALL_CONTAINING_LOCALES_AND_ALL
Expand the locale to include all the locales that contain it. "en_GB" would be "en_GB", "en", and all "".
-
LOCALE_AND_ALL_CONTAINED_LOCALES
public static final MLAnalysisMode LOCALE_AND_ALL_CONTAINED_LOCALES
Expand to all the locales that are contained by this. "en" would expand to "en", "en_GB", "en_US", ....
-
ALL_ONLY
public static final MLAnalysisMode ALL_ONLY
Just the all locale, "", === new Locale("", "", "")
-
ALL_LANGUAGES
public static final MLAnalysisMode ALL_LANGUAGES
All language matches. Only worry about language level matches for locale.
-
ALL_LANGUAGES_AND_ALL
public static final MLAnalysisMode ALL_LANGUAGES_AND_ALL
All language matches and ALL
-
EXACT_LANGUAGE
public static final MLAnalysisMode EXACT_LANGUAGE
Exact language matches (do not include all sub varients of the language)
-
EXACT_LANGUAGE_AND_ALL
public static final MLAnalysisMode EXACT_LANGUAGE_AND_ALL
Exact language matches (do not include all sub varients of the language) and ALL
-
EXACT_COUNRTY
public static final MLAnalysisMode EXACT_COUNRTY
Exact country matches (do not include all sub varients of the country)
-
EXACT_COUNTRY_AND_ALL
public static final MLAnalysisMode EXACT_COUNTRY_AND_ALL
Exact country matches (do not include all sub varients of the country) and ALL
-
ALL_COUNTRIES
public static final MLAnalysisMode ALL_COUNTRIES
All country matches
-
ALL_COUNTRIES_AND_ALL
public static final MLAnalysisMode ALL_COUNTRIES_AND_ALL
All countries and ALL
-
-
Method Detail
-
values
public static MLAnalysisMode[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (MLAnalysisMode c : MLAnalysisMode.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static MLAnalysisMode valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
getMLAnalysisMode
public static MLAnalysisMode getMLAnalysisMode(String mode)
-
includesAll
public abstract boolean includesAll()
-
includesContained
public abstract boolean includesContained()
-
includesContaining
public abstract boolean includesContaining()
-
includesExact
public abstract boolean includesExact()
-
includesAllLanguageMatches
public abstract boolean includesAllLanguageMatches()
-
includesExactLanguageMatch
public abstract boolean includesExactLanguageMatch()
-
includesAllCountryMatches
public abstract boolean includesAllCountryMatches()
-
includesExactCountryMatch
public abstract boolean includesExactCountryMatch()
-
getLocales
public static Set<Locale> getLocales(MLAnalysisMode mlAnalaysisMode, Locale locale, boolean withWildcards)
-
-