Class Hierarchy

• cjklib.build.UnihanBMPBuilder.BMPEntryGenerator
• cjklib.build.CharacterVariantBMPBuilder.BMPVariantGenerator
• cjklib.build.CharacterComponentLookupBuilder.CharacterComponentGenerator: Generates the component to character mapping.
• cjknife.CharacterInfo (script): Provides lookup method services.
• cjklib.characterlookup.CharacterLookup: CharacterLookup provides access to lookup methods related to Han characters.
• cjklib.build.CharacterRadicalStrokeCountBuilder.CharacterRadicalStrokeCountGenerator: Generates the character to radical/residual stroke count mapping.
• cjklib.build.CombinedCharacterResidualStrokeCountBuilder.CombinedResidualStrokeCountExtractor: Generates the character to residual stroke count mapping.
• cjklib.build.CombinedStrokeCountBuilder.CombinedStrokeCountGenerator: Generates the character stroke count mapping.
• xml.sax.handler.ContentHandler: Interface for receiving logical document content events.
  • cjklib.build.Kanjidic2Builder.XMLHandler: Extracts a list of given tags.
• cjklib.build.DatabaseBuilder: DatabaseBuilder provides the main class for building up a database for the cjklib package.
• cjklib.dbconnector.DatabaseConnector: A DatabaseConnector provides simple read access to a SQL database.
• csv.Dialect: Describe an Excel dialect.
  • cjklib.build.CSVFileLoader.DefaultDialect: Defines a default dialect for the case sniffing fails.
• cjklib.build.UnihanBuilder.EntryGenerator: Generates the entries of the Unihan table.
• cjklib.build.Kanjidic2Builder.KanjidicGenerator: Generates the KANJIDIC table.
• cjklib.build.ListGenerator: A simple generator for a given list of elements.
• cjklib.build.CharacterRadicalBuilder.RadicalExtractor: Generates the radical to character mapping from the Unihan table.
• cjklib.build.CharacterResidualStrokeCountBuilder.ResidualStrokeCountExtractor: Generates the character to residual stroke count mapping from the CharacterRadicalResidualStrokeCount table.
• cjklib.build.CharacterReadingBuilder.SimpleReadingSplitter: Generates the reading entities from the Unihan table.
  • cjklib.build.CharacterXHCReadingBuilder.XHCReadingSplitter: Generates the Xiandai Hanyu Cidian Pinyin syllables from the Unihan table.
  • cjklib.build.CharacterXHPCReadingBuilder.XHPCReadingSplitter: Generates the Xiandai Hanyu Pinlu Cidian Pinyin syllables from the Unihan table.
• cjklib.build.UnihanStrokeCountBuilder.StrokeCountExtractor: Extracts the character stroke count mapping.
• cjklib.build.StrokeCountBuilder.StrokeCountGenerator: Generates the character stroke count mapping.
• cjklib.build.EDICTFormatBuilder.TableGenerator: Generates the dictionary entries.
• cjklib.build.UnihanGenerator: Regular expression matching one entry in the Unihan database (e.g.
• cjklib.build.CharacterVariantBuilder.VariantGenerator: Generates the character to variant mapping from the Unihan table.
• cjklib.build.WordIndexBuilder.WordEntryGenerator: Generates words for a list of dictionary entries.
• object: The most base type
  • exceptions.BaseException: Common base class for all exceptions
    • exceptions.Exception: Common base class for all non-exit exceptions.
      • cjklib.exception.ConversionError: A ConversionError is raised on a general conversion exception (e.g.
        • cjklib.exception.AmbiguousConversionError: An AmbiguousConversionError is raised when a conversion of one entity from one reading to another is ambiguous.
      • cjklib.exception.DecompositionError: A DecompositionError is raised on a general decomposition exception (e.g.
        • cjklib.exception.AmbiguousDecompositonError: An AmbiguousDecompositonError is raised when decomposition of a string written in a reading is ambiguous.
        • cjklib.exception.InvalidEntityError: An InvalidEntityError is raised when a reading entity given (e.g.
      • cjklib.exception.NoInformationError: A NoInformationError is raised when the database lacks information for the given lookup value.
      • exceptions.StandardError: Base class for all standard Python exceptions that do not represent interpreter exiting.
        • exceptions.AssertionError: Assertion failed.
      • cjklib.exception.UnsupportedError: An UnsupportedError is raised when the given option is not supported.
  • cjklib.reading.converter.ReadingConverter: Defines an abstract converter between two or more character readings.
    • cjklib.reading.converter.BridgeConverter: Provides a ReadingConverter that converts between readings over a third reading called bridge reading.
    • cjklib.reading.converter.EntityWiseReadingConverter: Defines an abstract ReadingConverter between two or more readingss for doing entity wise conversion.
      • cjklib.reading.converter.CantoneseYaleDialectConverter: Provides a converter for different representations of the Cantonese Yale romanisation system.
      • cjklib.reading.converter.JyutpingDialectConverter: Provides a converter for different representations of the Cantonese romanisation Jyutping.
      • cjklib.reading.converter.RomanisationConverter: Defines an abstract ReadingConverter between two or more romanisations.
        • cjklib.reading.converter.GRPinyinConverter: Provides a converter between the Chinese romanisation Gwoyeu Romatzyh and Hanyu Pinyin.
        • cjklib.reading.converter.JyutpingYaleConverter: Provides a converter between the Cantonese romanisation systems Jyutping and Cantonese Yale.
        • cjklib.reading.converter.PinyinWadeGilesConverter: Provides a converter between the Chinese romanisation Hanyu Pinyin and Wade-Giles.
      • cjklib.reading.converter.WadeGilesDialectConverter: Provides a converter for different representations of the Mandarin Chinese romanisation Wade-Giles.
    • cjklib.reading.converter.GRDialectConverter: Provides a converter for different representations of the Chinese romanisation Gwoyeu Romatzyh.
    • cjklib.reading.converter.PinyinBrailleConverter: PinyinBrailleConverter defines a converter between the Chinese romanisation Hanyu Pinyin (with tone marks as numbers) and the Braille system for Mandarin.
    • cjklib.reading.converter.PinyinDialectConverter: Provides a converter for different representations of the Chinese romanisation Hanyu Pinyin.
    • cjklib.reading.converter.PinyinIPAConverter: Provides a converter between the Mandarin Chinese romanisation Hanyu Pinyin and the International Phonetic Alphabet (IPA) for Standard Mandarin.
  • cjklib.reading.ReadingFactory: Provides an abstract factory for creating ReadingOperators and ReadingConverters and a façade to directly access the methods offered by these classes.
  • cjklib.reading.operator.ReadingOperator: Defines an abstract operator on text written in a character reading.
    • cjklib.reading.operator.MandarinBrailleOperator: Provides an operator on strings written in the Braille system.
    • cjklib.reading.operator.RomanisationOperator: Defines an abstract ReadingOperator on text written in a romanisation, i.e.
      • cjklib.reading.operator.TonalRomanisationOperator: Provides an abstract RomanisationOperator for tonal languages incorporating methods from TonalFixedEntityOperator.
        • cjklib.reading.operator.CantoneseYaleOperator: Provides an operator for the Cantonese Yale romanisation.
        • cjklib.reading.operator.GROperator: Provides an operator for the Mandarin Gwoyeu Romatzyh romanisation.
        • cjklib.reading.operator.JyutpingOperator: Provides an operator for the Cantonese romanisation Jyutping made by the Linguistic Society of Hong Kong (LSHK).
        • cjklib.reading.operator.PinyinOperator: Provides an operator for the Mandarin romanisation Hanyu Pinyin.
        • cjklib.reading.operator.WadeGilesOperator: Provides an operator for the Mandarin Wade-Giles romanisation.
    • cjklib.reading.operator.SimpleEntityOperator: Provides an operator on readings with a single character per entity.
      • cjklib.reading.operator.HangulOperator: Provides an operator on Korean text written in Hangul.
      • cjklib.reading.operator.HiraganaOperator: Provides an operator on Japanese text written in Hiragana.
      • cjklib.reading.operator.KanaOperator: Provides an operator on Japanese text written in a mix of Hiragana and Katakana.
      • cjklib.reading.operator.KatakanaOperator: Provides an operator on Japanese text written in Katakana.
    • cjklib.reading.operator.TonalFixedEntityOperator: Provides an abstract ReadingOperator for tonal languages for a reading based on a fixed set of reading entities.
      • cjklib.reading.operator.TonalIPAOperator: Defines an operator on strings of a tonal language written in the International Phonetic Alphabet (IPA).
        • cjklib.reading.operator.CantoneseIPAOperator: Provides an operator on strings of the Cantonese language written in the International Phonetic Alphabet (IPA).
        • cjklib.reading.operator.MandarinIPAOperator: Provides an operator on strings in Mandarin Chinese written in the International Phonetic Alphabet (IPA).
      • cjklib.reading.operator.TonalRomanisationOperator: Provides an abstract RomanisationOperator for tonal languages incorporating methods from TonalFixedEntityOperator.
        • cjklib.reading.operator.CantoneseYaleOperator: Provides an operator for the Cantonese Yale romanisation.
        • cjklib.reading.operator.GROperator: Provides an operator for the Mandarin Gwoyeu Romatzyh romanisation.
        • cjklib.reading.operator.JyutpingOperator: Provides an operator for the Cantonese romanisation Jyutping made by the Linguistic Society of Hong Kong (LSHK).
        • cjklib.reading.operator.PinyinOperator: Provides an operator for the Mandarin romanisation Hanyu Pinyin.
        • cjklib.reading.operator.WadeGilesOperator: Provides an operator for the Mandarin Wade-Giles romanisation.
  • cjklib.reading.ReadingFactory.SimpleReadingConverterAdaptor: Defines a simple converter between two character readings that keeps the real converter doing the work in the background.
  • cjklib.build.TableBuilder: TableBuilder provides the abstract layout for classes that build a distinct table.
    • cjklib.build.CSVFileLoader: Builds a table by loading its data from a list of comma separated values (CSV).
      • cjklib.build.CantoneseIPAInitialFinalBuilder: Builds a mapping from Cantonese syllables in IPA to their initial/final parts.
      • cjklib.build.CantoneseYaleInitialNucleusCodaBuilder: Builds a mapping of Cantonese syllable in the Yale romanisation system to the syllables' initial, nucleus and coda.
      • cjklib.build.CantoneseYaleSyllablesBuilder: Builds a list of Cantonese Yale syllables.
      • cjklib.build.CharacterDecompositionBuilder: Builds a mapping between characters and their decomposition.
      • cjklib.build.GRAbbreviationBuilder: Builds a list of Gwoyeu Romatzyh abbreviated spellings.
      • cjklib.build.GRRhotacisedFinalsBuilder: Builds a list of Gwoyeu Romatzyh rhotacised finals.
      • cjklib.build.GRSyllablesBuilder: Builds a list of Gwoyeu Romatzyh syllables.
      • cjklib.build.JyutpingIPAMappingBuilder: Builds a mapping between syllables in Jyutping and their representation in IPA.
      • cjklib.build.JyutpingInitialFinalBuilder: Builds a mapping from Jyutping syllables to their initial/final parts.
      • cjklib.build.JyutpingSyllablesBuilder: Builds a list of Jyutping syllables.
      • cjklib.build.JyutpingYaleMappingBuilder: Builds a mapping between syllables in Jyutping and the Yale romanization system.
      • cjklib.build.KangxiRadicalBuilder: Builds a mapping between Kangxi radical index and radical characters.
      • cjklib.build.KangxiRadicalIsolatedCharacterBuilder: Builds a mapping between Kangxi radical index and radical equivalent characters without radical form.
      • cjklib.build.LocaleCharacterVariantBuilder: Builds a mapping between a character under a locale and its default variant.
      • cjklib.build.MandarinBraileFinalBuilder: Builds a mapping of Mandarin Chinese syllable finals in Pinyin to Braille characters.
      • cjklib.build.MandarinBraileInitialBuilder: Builds a mapping of Mandarin Chinese syllable initials in Pinyin to Braille characters.
      • cjklib.build.MandarinIPAInitialFinalBuilder: Builds a mapping from Mandarin syllables in IPA to their initial/final parts.
      • cjklib.build.PinyinGRMappingBuilder: Builds a mapping between syllables in Pinyin and Gwoyeu Romatzyh.
      • cjklib.build.PinyinIPAMappingBuilder: Builds a mapping between syllables in Pinyin and their representation in IPA.
      • cjklib.build.PinyinInitialFinalBuilder: Builds a mapping from Pinyin syllables to their initial/final parts.
      • cjklib.build.PinyinSyllablesBuilder: Builds a list of Pinyin syllables.
      • cjklib.build.RadicalEquivalentCharacterBuilder: Builds a mapping between Unicode radical forms and Unicode radical variants on one side and equivalent characters on the other side.
      • cjklib.build.StrokeOrderBuilder: Builds a mapping between characters and their stroke order.
      • cjklib.build.StrokesBuilder: Builds a list of strokes and their names.
      • cjklib.build.WadeGilesPinyinMappingBuilder: Builds a mapping between syllables in Wade-Giles and Pinyin.
      • cjklib.build.WadeGilesSyllablesBuilder: Builds a list of Wade-Giles syllables.
    • cjklib.build.EntryGeneratorBuilder: Implements an abstract class for building a table from a generator providing entries.
      • cjklib.build.CharacterComponentLookupBuilder: Builds a mapping between characters and their components.
      • cjklib.build.CharacterPinyinBuilder: Builds the character Pinyin mapping table from the several sources.
      • cjklib.build.CharacterRadicalStrokeCountBuilder: Builds a mapping between characters and their radical with stroke count of residual components.
      • cjklib.build.CharacterResidualStrokeCountBuilder: Builds a mapping between characters and their residual stroke count when splitting of the radical form.
        • cjklib.build.CombinedCharacterResidualStrokeCountBuilder: Builds a mapping between characters and their residual stroke count when splitting of the radical form.
      • cjklib.build.CharacterVariantBuilder: Builds a character variant mapping table from the Unihan database.
        • cjklib.build.CharacterVariantBMPBuilder: Builds a character variant mapping table from the Unihan database for characters from the Basic Multilingual Plane (BMP) with code values between U+0000 and U+FFFF.
      • cjklib.build.EDICTFormatBuilder: Provides an abstract class for loading EDICT formatted dictionaries.
        • cjklib.build.CEDICTFormatBuilder: Provides an abstract class for loading CEDICT formatted dictionaries.
          • cjklib.build.CEDICTBuilder: Builds the CEDICT dictionary.
          • cjklib.build.HanDeDictBuilder: Builds the HanDeDict dictionary.
        • cjklib.build.CEDICTGRBuilder: Builds the CEDICT-GR dictionary.
        • cjklib.build.EDICTBuilder: Builds the EDICT dictionary.
      • cjklib.build.Kanjidic2Builder: Builds the Kanjidic database from the Kanjidic2 XML file http://www.csse.monash.edu.au/~jwb/kanjidic2/.
      • cjklib.build.StrokeCountBuilder: Builds a mapping between characters and their stroke count.
        • cjklib.build.CombinedStrokeCountBuilder: Builds a mapping between characters and their stroke count.
      • cjklib.build.UnihanBuilder: Builds the Unihan database from the Unihan file provided by Unicode.
        • cjklib.build.SlimUnihanBuilder: Builds a slim version of the Unihan database.
          • cjklib.build.SlimUnihanBMPBuilder: Builds a slim version of the Unihan database from the Unihan file provided by Unicode for characters from the Basic Multilingual Plane (BMP) with code values between U+0000 and U+FFFF.
        • cjklib.build.UnihanBMPBuilder: Builds the Unihan database from the Unihan file provided by Unicode for characters from the Basic Multilingual Plane (BMP) with code values between U+0000 and U+FFFF.
          • cjklib.build.SlimUnihanBMPBuilder: Builds a slim version of the Unihan database from the Unihan file provided by Unicode for characters from the Basic Multilingual Plane (BMP) with code values between U+0000 and U+FFFF.
      • cjklib.build.UnihanCharacterSetBuilder: Builds a simple list of characters that belong to a specific class using the Unihan data.
        • cjklib.build.GB2312SetBuilder: Builds a simple list of all characters in the Chinese standard GB2312-80.
        • cjklib.build.IICoreSetBuilder: Builds a simple list of all characters in IICore (Unicode International Ideograph Core).
      • cjklib.build.UnihanDerivedBuilder: Provides an abstract class for building a table with a relation between a Chinese character and another column using the Unihan database.
        • cjklib.build.CharacterRadicalBuilder: Provides an abstract class for building a character radical mapping table using the Unihan database.
          • cjklib.build.CharacterJapaneseRadicalBuilder: Builds the character Japanese radical mapping table from the Unihan database.
          • cjklib.build.CharacterKanWaRadicalBuilder: Builds the character Dai Kan-Wa jiten radical mapping table from the Unihan database.
          • cjklib.build.CharacterKangxiRadicalBuilder: Builds the character Kangxi radical mapping table from the Unihan database.
          • cjklib.build.CharacterKoreanRadicalBuilder: Builds the character Korean radical mapping table from the Unihan database.
        • cjklib.build.CharacterReadingBuilder: Provides an abstract class for building a character reading mapping table using the Unihan database.
          • cjklib.build.CharacterHangulBuilder: Builds the character Hangul mapping table from the Unihan database.
          • cjklib.build.CharacterJapaneseKunBuilder: Builds the character Kun'yomi mapping table from the Unihan database.
          • cjklib.build.CharacterJapaneseOnBuilder: Builds the character On'yomi mapping table from the Unihan database.
          • cjklib.build.CharacterJyutpingBuilder: Builds the character Jyutping mapping table from the Unihan database.
          • cjklib.build.CharacterUnihanPinyinBuilder: Builds the character Pinyin mapping table from the Unihan database.
          • cjklib.build.CharacterVietnameseBuilder: Builds the character Vietnamese mapping table from the Unihan database.
          • cjklib.build.CharacterXHCReadingBuilder: Builds the Xiandai Hanyu Cidian Pinyin mapping table using the Unihan database.
          • cjklib.build.CharacterXHPCReadingBuilder: Builds the Xiandai Hanyu Pinlu Cidian Pinyin mapping table using the Unihan database.
        • cjklib.build.UnihanStrokeCountBuilder: Builds a mapping between characters and their stroke count using the Unihan data.
      • cjklib.build.WordIndexBuilder: Builds a translation word index for a given dictionary.
        • cjklib.build.CEDICTGRWordIndexBuilder: Builds the word index of the CEDICT-GR dictionary.
        • cjklib.build.CEDICTWordIndexBuilder: Builds the word index of the CEDICT dictionary.
        • cjklib.build.EDICTWordIndexBuilder: Builds the word index of the EDICT dictionary.
        • cjklib.build.HanDeDictWordIndexBuilder: Builds the word index of the HanDeDict dictionary.
      • cjklib.build.ZVariantBuilder: Builds a list of glyph indices for characters.
  • unittest.TestCase: A class whose instances are single test cases.
    • cjklib.test.CharacterLookupTestCase: Base class for testing the characterlookup.CharacterLookup class.
      • cjklib.test.CharacterLookupReadingMethodsTestCase: Runs consistency checks on the reading methods of the characterlookup.CharacterLookup class.
    • cjklib.test.GRTestCase: Tests GR conversion methods.
    • cjklib.test.ReadingConverterTestCase: Base class for testing of ReadingConverters.
      • cjklib.test.ReadingConverterValueTestCase: Runs reference checks on ReadingConverters.
    • cjklib.test.ReadingOperatorTestCase: Base class for testing of ReadingOperators.
      • cjklib.test.CharacterLookupReadingMethodsTestCase: Runs consistency checks on the reading methods of the characterlookup.CharacterLookup class.
      • cjklib.test.ReadingOperatorConsistencyTestCase: Runs consistency checks on ReadingOperators.
      • cjklib.test.ReadingOperatorValueTestCase: Runs reference checks on ReadingOperators.
  • dict: dict() -> new empty dictionary.
    • cjklib.test.ImmutableDict: A hashable dict.