org.alfresco.repo.search
Class MLAnalysisMode

java.lang.Object
  extended by java.lang.Enum
      extended by org.alfresco.repo.search.MLAnalysisMode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable

public class MLAnalysisMode
extends java.lang.Enum

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.

See Also:
Serialized Form

Field Summary
static MLAnalysisMode ALL_COUNTRIES
          All country matches
static MLAnalysisMode ALL_COUNTRIES_AND_ALL
          All countries and ALL
static MLAnalysisMode ALL_LANGUAGES
          All language matches.
static MLAnalysisMode ALL_LANGUAGES_AND_ALL
          All language matches and ALL
static MLAnalysisMode ALL_ONLY
          Just the all locale, "", === new Locale("", "", "")
static MLAnalysisMode EXACT_COUNRTY
          Exact country matches (do not include all sub varients of the country)
static MLAnalysisMode EXACT_COUNTRY_AND_ALL
          Exact country matches (do not include all sub varients of the country) and ALL
static MLAnalysisMode EXACT_LANGUAGE
          Exact language matches (do not include all sub varients of the language)
static MLAnalysisMode EXACT_LANGUAGE_AND_ALL
          Exact language matches (do not include all sub varients of the language) and ALL
static MLAnalysisMode LOCALE_AND_ALL
          Only the exact locale and no locale === locale + all languages
static MLAnalysisMode LOCALE_AND_ALL_CONTAINED_LOCALES
          Expand to all the locales that are contained by this.
static MLAnalysisMode LOCALE_AND_ALL_CONTAINING_LOCALES
          Expand the locale to include all the locales that contain it.
static MLAnalysisMode LOCALE_AND_ALL_CONTAINING_LOCALES_AND_ALL
          Expand the locale to include all the locales that contain it.
static MLAnalysisMode LOCALE_ONLY
          Only the exact locale is used.
 
Method Summary
static java.util.Set getLocales(MLAnalysisMode mlAnalaysisMode, java.util.Locale locale, boolean withWildcards)
           
static MLAnalysisMode getMLAnalysisMode(java.lang.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(java.lang.String name)
           
static MLAnalysisMode[] values()
           
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field 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()

valueOf

public static MLAnalysisMode valueOf(java.lang.String name)

getMLAnalysisMode

public static MLAnalysisMode getMLAnalysisMode(java.lang.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 java.util.Set getLocales(MLAnalysisMode mlAnalaysisMode,
                                       java.util.Locale locale,
                                       boolean withWildcards)


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.