Localization (DocJGenerator API)

java.lang.Object
- org.docgene.model.globals.Localization

All Implemented Interfaces:: Locales

public class Localization
extends java.lang.Object
implements Locales

Hold the localization for the wiki.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ABOUT` "about": The name for the "The article is about" text.
`static java.lang.String`	`AND` "and": The name for the "and" text.
`static java.lang.String`	`BEGIN_REVIEW` "beginReview": The name for the the start review button in review.
`static java.lang.String`	`CATEGORIES` "categories": The name for accessing the Categories page.
`static java.lang.String`	`CATEGORY` "category": The name for each Category.
`static java.lang.String`	`CONTAINING` "containing": The name for the full text search category.
`static java.lang.String`	`DAYS` "days": The name for the days.
`static java.lang.String`	`DICTIONARY` "dictionary": The name for accessing the A page.
`static java.lang.String`	`DISAMB_CAT` "disambCat": The name for the disambiguation category text.
`static java.lang.String`	`DISAMB_PRES` "disambPres": The name for a disambiguation article presentation.
`static java.lang.String`	`DISAMB_TEXT` "disambText": The name for the disambiguation text.
`static java.lang.String`	`FALLBACK_TITLE` "fallback": The name for fallback articles title.
`static java.lang.String`	`FOR` "for": The name for the "For ..., see" text.
`static java.lang.String`	`FROM` "from": The name for the "from" text.
`static java.lang.String`	`FULLTEXTSEARCH` "searchResults": The name for accessing the Full Text Search page title.
`static java.lang.String`	`GLOSSARY` "glossary": The name for the glossary.
`static java.lang.String`	`HOME` "home": The name for accessing the Home page.
`static java.lang.String`	`INDEX_CHAPTER` "index": The title for the index chapter.
`static java.lang.String`	`INTRO_CHAPTER` "introduction": The title for the introduction chapter.
`static java.lang.String`	`LANGUAGE` "language": The language name.
`static java.lang.String`	`LINKS_FROM` "linksFrom": The name for the "Pages that link to" text.
`static java.lang.String`	`LOCALE` "locale": The localization name.
`static java.lang.String`	`MAIN_ARTICLE` "mainArticle": The name for the Main Article reference.
`static java.lang.String`	`MISC_CHAPTER` "miscellanous": The title for the miscellanous topics chapter.
`static java.lang.String`	`MONTHS` "months": The name for the months.
`static java.lang.String`	`NEXT` "next": The name for the the next comment in review.
`static java.lang.String`	`NOTES` "notes": The name for the Notes chapter.
`static java.lang.String`	`NOTES_CHAPTER` "notesChapter": The title for the notes chapter.
`static java.lang.String`	`PREVIOUS` "previous": The name for the the previous comment in review.
`static java.lang.String`	`REASON` "reason": The name for the "reason" text.
`static java.lang.String`	`SEARCH` "search": The name for the "Search..." text.
`static java.lang.String`	`SEE` "see": The name for the "For ..., see" text.
`static java.lang.String`	`SEEALSO` "seealso": The name for the See Also chapter.
`static java.lang.String`	`START_REVIEW` "startReview": The name for the the start review button in review.
`static java.lang.String`	`TOC_CHAPTER` "toc": The title for the TOC_CHAPTER chapter.
`static java.lang.String`	`YEARS` "years": The name for the years.

Fields inherited from interface org.docgene.model.globals.Locales
ENGLISH, FRENCH, GERMAN, ITALIAN, RUSSIAN, SPANISH

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Localization`	`getInstance()` Return the unique instance.
`java.util.Locale`	`getLocale()` Return the Localization associated Locale.
`java.lang.String`	`getLocalization()` Return the Localization.
`java.lang.String`	`getName(java.lang.String key)` Return the name for a key.
`boolean`	`hasKey(java.lang.String key)` Return true if a key is supported.
`void`	`reset()` Reset the Localization and sets an en-us Localization.
`boolean`	`setLocalization(java.lang.String locale)` Set the Localization for one of the built-in locale.
`void`	`setLocalization(java.lang.String locale, java.util.Map<java.lang.String,java.lang.String> localized)` Set the properties-values for the Localization.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOCALE
```
public static final java.lang.String LOCALE
```
    "locale": The localization name.
    
    See Also:
    
    Constant Field Values
  - LANGUAGE
```
public static final java.lang.String LANGUAGE
```
    "language": The language name.
    
    See Also:
    
    Constant Field Values
  - HOME
```
public static final java.lang.String HOME
```
    "home": The name for accessing the Home page.
    
    See Also:
    
    Constant Field Values
  - DICTIONARY
```
public static final java.lang.String DICTIONARY
```
    "dictionary": The name for accessing the A page.
    
    See Also:
    
    Constant Field Values
  - CATEGORIES
```
public static final java.lang.String CATEGORIES
```
    "categories": The name for accessing the Categories page.
    
    See Also:
    
    Constant Field Values
  - CATEGORY
```
public static final java.lang.String CATEGORY
```
    "category": The name for each Category.
    
    See Also:
    
    Constant Field Values
  - ABOUT
```
public static final java.lang.String ABOUT
```
    "about": The name for the "The article is about" text.
    
    See Also:
    
    Constant Field Values
  - FOR
```
public static final java.lang.String FOR
```
    "for": The name for the "For ..., see" text.
    
    See Also:
    
    Constant Field Values
  - AND
```
public static final java.lang.String AND
```
    "and": The name for the "and" text.
    
    See Also:
    
    Constant Field Values
  - SEE
```
public static final java.lang.String SEE
```
    "see": The name for the "For ..., see" text.
    
    See Also:
    
    Constant Field Values
  - LINKS_FROM
```
public static final java.lang.String LINKS_FROM
```
    "linksFrom": The name for the "Pages that link to" text.
    
    See Also:
    
    Constant Field Values
  - MAIN_ARTICLE
```
public static final java.lang.String MAIN_ARTICLE
```
    "mainArticle": The name for the Main Article reference.
    
    See Also:
    
    Constant Field Values
  - NOTES
```
public static final java.lang.String NOTES
```
    "notes": The name for the Notes chapter.
    
    See Also:
    
    Constant Field Values
  - SEEALSO
```
public static final java.lang.String SEEALSO
```
    "seealso": The name for the See Also chapter.
    
    See Also:
    
    Constant Field Values
  - DISAMB_TEXT
```
public static final java.lang.String DISAMB_TEXT
```
    "disambText": The name for the disambiguation text.
    
    See Also:
    
    Constant Field Values
  - DISAMB_CAT
```
public static final java.lang.String DISAMB_CAT
```
    "disambCat": The name for the disambiguation category text.
    
    See Also:
    
    Constant Field Values
  - DISAMB_PRES
```
public static final java.lang.String DISAMB_PRES
```
    "disambPres": The name for a disambiguation article presentation.
    
    See Also:
    
    Constant Field Values
  - MISC_CHAPTER
```
public static final java.lang.String MISC_CHAPTER
```
    "miscellanous": The title for the miscellanous topics chapter.
    
    See Also:
    
    Constant Field Values
  - INTRO_CHAPTER
```
public static final java.lang.String INTRO_CHAPTER
```
    "introduction": The title for the introduction chapter.
    
    See Also:
    
    Constant Field Values
  - INDEX_CHAPTER
```
public static final java.lang.String INDEX_CHAPTER
```
    "index": The title for the index chapter.
    
    See Also:
    
    Constant Field Values
  - NOTES_CHAPTER
```
public static final java.lang.String NOTES_CHAPTER
```
    "notesChapter": The title for the notes chapter.
    
    See Also:
    
    Constant Field Values
  - TOC_CHAPTER
```
public static final java.lang.String TOC_CHAPTER
```
    "toc": The title for the TOC_CHAPTER chapter.
    
    See Also:
    
    Constant Field Values
  - SEARCH
```
public static final java.lang.String SEARCH
```
    "search": The name for the "Search..." text.
    
    See Also:
    
    Constant Field Values
  - GLOSSARY
```
public static final java.lang.String GLOSSARY
```
    "glossary": The name for the glossary.
    
    See Also:
    
    Constant Field Values
  - FALLBACK_TITLE
```
public static final java.lang.String FALLBACK_TITLE
```
    "fallback": The name for fallback articles title.
    
    See Also:
    
    Constant Field Values
  - FULLTEXTSEARCH
```
public static final java.lang.String FULLTEXTSEARCH
```
    "searchResults": The name for accessing the Full Text Search page title.
    
    See Also:
    
    Constant Field Values
  - CONTAINING
```
public static final java.lang.String CONTAINING
```
    "containing": The name for the full text search category.
    
    See Also:
    
    Constant Field Values
  - DAYS
```
public static final java.lang.String DAYS
```
    "days": The name for the days.
    
    See Also:
    
    Constant Field Values
  - MONTHS
```
public static final java.lang.String MONTHS
```
    "months": The name for the months.
    
    See Also:
    
    Constant Field Values
  - YEARS
```
public static final java.lang.String YEARS
```
    "years": The name for the years.
    
    See Also:
    
    Constant Field Values
  - PREVIOUS
```
public static final java.lang.String PREVIOUS
```
    "previous": The name for the the previous comment in review.
    
    See Also:
    
    Constant Field Values
  - NEXT
```
public static final java.lang.String NEXT
```
    "next": The name for the the next comment in review.
    
    See Also:
    
    Constant Field Values
  - START_REVIEW
```
public static final java.lang.String START_REVIEW
```
    "startReview": The name for the the start review button in review.
    
    See Also:
    
    Constant Field Values
  - BEGIN_REVIEW
```
public static final java.lang.String BEGIN_REVIEW
```
    "beginReview": The name for the the start review button in review.
    
    See Also:
    
    Constant Field Values
  - FROM
```
public static final java.lang.String FROM
```
    "from": The name for the "from" text.
    
    See Also:
    
    Constant Field Values
  - REASON
```
public static final java.lang.String REASON
```
    "reason": The name for the "reason" text.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getInstance
```
public static Localization getInstance()
```
    Return the unique instance.
    
    Returns:
    
    the unique instance
  - getLocale
```
public java.util.Locale getLocale()
```
    Return the Localization associated Locale. It may return null if there is no Locale for the getLocalization() does not refer to an existing Locale.
    
    Returns:
    
    the Locale
  - getLocalization
```
public java.lang.String getLocalization()
```
    Return the Localization.
    
    Returns:
    
    the Localization
  - reset
```
public void reset()
```
    Reset the Localization and sets an en-us Localization.
  - setLocalization
```
public void setLocalization(java.lang.String locale,
                            java.util.Map<java.lang.String,java.lang.String> localized)
```
    Set the properties-values for the Localization.
    
    Parameters:
    
    locale - the locale
    
    localized - the properties-values Map
  - setLocalization
```
public boolean setLocalization(java.lang.String locale)
```
    Set the Localization for one of the built-in locale. The supported locales are:
    - "en": En-us localization (the default)
    - "fr": French localization
    - "de": German localization
    - "es": Spanish localization
    - "it": Italian localization
    - "ru": Russian localization
    Parameters:
    
    locale - the locale
    
    Returns:
    
    true if the locale was found
  - hasKey
```
public boolean hasKey(java.lang.String key)
```
    Return true if a key is supported.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    true if the key is supported
  - getName
```
public java.lang.String getName(java.lang.String key)
```
    Return the name for a key. It will for example return "Home" for the HOME key in "en-us", or "Accueil" in "fr".
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the name

Class Localization

Field Summary

Fields inherited from interface org.docgene.model.globals.Locales

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOCALE

LANGUAGE

HOME

DICTIONARY

CATEGORIES

CATEGORY

ABOUT

FOR

AND

SEE

LINKS_FROM

MAIN_ARTICLE

NOTES

SEEALSO

DISAMB_TEXT

DISAMB_CAT

DISAMB_PRES

MISC_CHAPTER

INTRO_CHAPTER

INDEX_CHAPTER

NOTES_CHAPTER

TOC_CHAPTER

SEARCH

GLOSSARY

FALLBACK_TITLE

FULLTEXTSEARCH

CONTAINING

DAYS

MONTHS

YEARS

PREVIOUS

NEXT

START_REVIEW

BEGIN_REVIEW

FROM

REASON

Method Detail

getInstance

getLocale

getLocalization

reset

setLocalization

setLocalization

hasKey

getName