annotate Lang/AbstractTranslationSet.cs @ 72:cec6c4c0892d

Fixes #34: Get name for translation * Add code for translation name fetching (using native name)
author IBBoard <dev@ibboard.co.uk>
date Tue, 06 Apr 2010 18:20:14 +0000
parents b5d7e8b93205
children 091bfa54d6c7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
69
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1 // This file (AbstractTranslationSet.cs) is a part of the IBBoard project and is copyright 2010 IBBoard
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
2 //
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
3 // The file and the library/program it is in are licensed and distributed, without warranty, under the GNU Affero GPL license, either version 3 of the License or (at your option) any later version. Please see COPYING for more information and the full license.
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
4
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
5 using System;
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
6 using System.Collections.Generic;
72
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
7 using System.Globalization;
69
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
8
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
9 namespace IBBoard.Lang
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
10 {
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
11 /// <summary>
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
12 /// A collection of translations for a given language. The abstract class must be extended by implementations that
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
13 /// provide different ways of loading the data.
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
14 /// </summary>
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
15 public class AbstractTranslationSet
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
16 {
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
17 private string langCode;
72
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
18 private string langName;
69
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
19 protected Dictionary<string, string> translations;
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
20
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
21 public AbstractTranslationSet(string languageCode)
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
22 {
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
23 langCode = languageCode;
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
24 translations = new Dictionary<string, string>();
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
25 }
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
26
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
27 /// <summary>
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
28 /// Gets the language code that this translation claims to be for
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
29 /// </summary>
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
30 public string LanguageCode
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
31 {
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
32 get { return langCode; }
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
33 }
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
34
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
35 /// <summary>
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
36 /// Gets a translation from the translation set, or <code>null</code> if the translation doesn't exist.
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
37 /// </summary>
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
38 /// <param name="key">
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
39 /// The key (ID) of the translation to retrieve
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
40 /// </param>
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
41 public string this[string key]
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
42 {
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
43 set
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
44 {
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
45 translations[key] = value;
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
46 }
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
47 get
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
48 {
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
49 return DictionaryUtils.GetValue(translations, key);
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
50 }
72
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
51 }
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
52
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
53 public string LanguageName
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
54 {
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
55 get
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
56 {
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
57 if (langName == null)
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
58 {
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
59 LoadLangName();
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
60 }
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
61
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
62 return langName;
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
63 }
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
64 }
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
65
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
66 private void LoadLangName()
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
67 {
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
68 try
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
69 {
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
70 CultureInfo culture = CultureInfo.GetCultureInfo(langCode);
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
71 langName = culture.NativeName;
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
72 }
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
73 catch(ArgumentException)
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
74 {
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
75 langName = "Unknown ("+langCode+")";
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
76 }
cec6c4c0892d Fixes #34: Get name for translation
IBBoard <dev@ibboard.co.uk>
parents: 69
diff changeset
77 }
69
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
78 }
b5d7e8b93205 Re #30: Improve Translations API
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
79 }