com.alee.managers.language.data

Class Dictionary

java.lang.Object

com.alee.managers.language.data.Dictionary

All Implemented Interfaces:

Identifiable, Mergeable, Serializable, Cloneable

public final class Dictionary
extends Object
implements Identifiable, Mergeable, Cloneable, Serializable

Dictionary can store multiple language Records and Dictionarys. Dictionary is a main component used within LanguageManager to access actual translations.

Author:

Mikle Garin

See Also:

How to use LanguageManager, LanguageManager, Language, Record, TranslationInformation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Dictionary() Constructs new Dictionary.
Dictionary(InputStream inputStream) Loads Dictionary from the specified InputStream.
Dictionary(Resource resource) Loads Dictionary from the specified Resource.
Dictionary(String prefix) Constructs new Dictionary.
Dictionary(String prefix, String name) Constructs new Dictionary.

Method Summary

Modifier and Type	Method and Description
void	addDictionary(Dictionary dictionary) Adds new child Dictionary.
void	addRecord(Record record) Adds new Record into this Dictionary and returns it.
void	addTranslation(TranslationInformation translation) Adds TranslationInformation for this Dictionary.
void	clearDictionaries() Removes all child Dictionarys.
void	clearRecords() Removes all Records from this Dictionary.
protected List<Locale>	collectSupportedLocales(List<Locale> locales) Returns all Locales from this Dictionary and all sub-Dictionary Records.
int	dictionariesCount() Returns amount of sub-Dictionarys in this Dictionary.
boolean	equals(Object obj)
List<Locale>	getAllLocales() Returns List of all Locale from this Dictionary.
List<Dictionary>	getDictionaries() Returns List of Dictionarys this Dictionary contains.
String	getId() Returns unique object identifier.
Set<String>	getKeys() Returns Set of all Record keys for this Dictionary.
String	getName() Returns Dictionary name.
String	getPrefix() Returns Dictionary prefix.
Record	getRecord(String key, Locale locale) Returns Record for the specified language key.
List<Record>	getRecords() Returns List of Records this Dictionary contains.
List<Locale>	getSupportedLocales() Returns List of Locale supported by this Dictionary.
TranslationInformation	getTranslation(Locale locale) Returns TranslationInformation for the specified Locale.
List<TranslationInformation>	getTranslations() Returns List of TranslationInformations contained in this dictionary.
int	recordsCount() Returns amount of Records in this Dictionary.
void	removeDictionary(Dictionary dictionary) Removes child Dictionary.
void	removeRecord(Record record) Removes Record from this Dictionary.
void	removeRecord(String key) Removes Record with the specified key from this Dictionary.
void	setDictionaries(List<Dictionary> dictionaries) Sets List of Dictionarys for this Dictionary.
void	setName(String name) Sets Dictionary name.
void	setPrefix(String prefix) Sets Dictionary prefix.
void	setRecords(List<Record> records) Sets List of Records for this Dictionary.
void	setTranslations(List<TranslationInformation> translations) Sets List of TranslationInformations for this dictionary.
String	toString()
int	totalRecordsCount() Returns total amount of Records in this Dictionary and all sub-Dictionarys.

Methods inherited from class java.lang.Object

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

Constructor Detail

Dictionary

public Dictionary()

Constructs new Dictionary.

Dictionary

public Dictionary(@Nullable
                  String prefix)

Constructs new Dictionary.

Parameters:

prefix - Dictionary key prefix

Dictionary

public Dictionary(@Nullable
                  String prefix,
                  @Nullable
                  String name)

Constructs new Dictionary.

Parameters:

prefix - Dictionary key prefix

name - Dictionary name

Dictionary

public Dictionary(@NotNull
                  Resource resource)

Loads Dictionary from the specified Resource.

Parameters:

resource - Resource to load Dictionary from

Dictionary

public Dictionary(@NotNull
                  InputStream inputStream)

Loads Dictionary from the specified InputStream.

Parameters:

inputStream - InputStream to load Dictionary from

Method Detail

getId

@NotNull
public String getId()

Description copied from interface: Identifiable

Returns unique object identifier. todo Probably change back to NotNull in future

Specified by:

getId in interface Identifiable

Returns:

unique object identifier

getName

@Nullable
public String getName()

Returns Dictionary name.

Returns:

Dictionary name

setName

public void setName(@Nullable
                    String name)

Sets Dictionary name.

Parameters:

name - new Dictionary name

getPrefix

@Nullable
public String getPrefix()

Returns Dictionary prefix.

Returns:

Dictionary prefix

setPrefix

public void setPrefix(@Nullable
                      String prefix)

Sets Dictionary prefix.

Parameters:

prefix - new Dictionary prefix

recordsCount

public int recordsCount()

Returns amount of Records in this Dictionary. Note that this method doesn't count Records from sub-Dictionarys.

Returns:

amount of Records in this Dictionary

totalRecordsCount

public int totalRecordsCount()

Returns total amount of Records in this Dictionary and all sub-Dictionarys.

Returns:

total amount of Records in this Dictionary and all sub-Dictionarys

getRecords

@NotNull
public List<Record> getRecords()

Returns List of Records this Dictionary contains.

Returns:

List of Records this Dictionary contains

setRecords

public void setRecords(@Nullable
                       List<Record> records)

Sets List of Records for this Dictionary.

Parameters:

records - new List of Records for this Dictionary

getRecord

@Nullable
public Record getRecord(@NotNull
                                  String key,
                                  @NotNull
                                  Locale locale)

Returns Record for the specified language key. Search will be perfomed in this Dictionary and all sub-Dictionarys.

Parameters:

key - Record language key

locale - Locale

Returns:

Record for the specified language key

addRecord

public void addRecord(@NotNull
                      Record record)

Adds new Record into this Dictionary and returns it.

Parameters:

record - Record to add

removeRecord

public void removeRecord(@NotNull
                         Record record)

Removes Record from this Dictionary.

Parameters:

record - Record to remove

removeRecord

public void removeRecord(@NotNull
                         String key)

Removes Record with the specified key from this Dictionary.

Parameters:

key - key of Record to remove

clearRecords

public void clearRecords()

Removes all Records from this Dictionary.

getKeys

@NotNull
public Set<String> getKeys()

Returns Set of all Record keys for this Dictionary. This will include all keys for Records in sub-Dictionarys.

Returns:

Set of all Record keys for this Dictionary

dictionariesCount

public int dictionariesCount()

Returns amount of sub-Dictionarys in this Dictionary.

Returns:

amount of sub-Dictionarys in this Dictionary

getDictionaries

@NotNull
public List<Dictionary> getDictionaries()

Returns List of Dictionarys this Dictionary contains.

Returns:

List of Dictionarys this Dictionary contains

setDictionaries

public void setDictionaries(@Nullable
                            List<Dictionary> dictionaries)

Sets List of Dictionarys for this Dictionary.

Parameters:

dictionaries - new List of Dictionarys for this Dictionary

addDictionary

public void addDictionary(@NotNull
                          Dictionary dictionary)

Adds new child Dictionary.

Parameters:

dictionary - child Dictionary to add

removeDictionary

public void removeDictionary(@NotNull
                             Dictionary dictionary)

Removes child Dictionary.

Parameters:

dictionary - child Dictionary to remove

clearDictionaries

public void clearDictionaries()

Removes all child Dictionarys.

getTranslations

@NotNull
public List<TranslationInformation> getTranslations()

Returns List of TranslationInformations contained in this dictionary.

Returns:

List of TranslationInformations contained in this dictionary

setTranslations

public void setTranslations(@Nullable
                            List<TranslationInformation> translations)

Sets List of TranslationInformations for this dictionary.

Parameters:

translations - new List of TranslationInformations for this dictionary

getTranslation

@Nullable
public TranslationInformation getTranslation(@NotNull
                                                       Locale locale)

Returns TranslationInformation for the specified Locale.

Parameters:

locale - Locale

Returns:

TranslationInformation for the specified Locale

addTranslation

public void addTranslation(@NotNull
                           TranslationInformation translation)

Adds TranslationInformation for this Dictionary.

Parameters:

translation - TranslationInformation to add

getAllLocales

@NotNull
public List<Locale> getAllLocales()

Returns List of all Locale from this Dictionary.

Returns:

List of all Locale from this Dictionary

getSupportedLocales

@NotNull
public List<Locale> getSupportedLocales()

Returns List of Locale supported by this Dictionary. Language codes are used to detect whether or not specific Locale is supported. We can't say that for instance "en_US" Locale is not supported if we have "en" or "en_GB" translation available. Even though it is not strict "supported" case it is much better than having fully distinct translation for each country.

Returns:

List of Locale supported by this Dictionary

collectSupportedLocales

@Nullable
protected List<Locale> collectSupportedLocales(@Nullable
                                                         List<Locale> locales)

Returns all Locales from this Dictionary and all sub-Dictionary Records. Note that Locales intersection is only used across different Dictionarys. Singke Dictionary can have Record with varying Locales but they will all be counted in for it. Basically any Locale found within single Dictionary is considered to be supported.

Parameters:

locales - List of Locales collected so far, can be null

Returns:

all Locales from this Dictionary and all sub-Dictionary Records

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Object

toString

@NotNull
public String toString()

Overrides:

toString in class Object