Creates an instance of the JyutpingYaleConverter.

Parameters:

• args - optional list of RomanisationOperators to use for handling source and target readings.
• options - extra options
• dbConnectInst - instance of a DatabaseConnector, if none is given, default settings will be assumed.
• sourceOperators - list of ReadingOperators used for handling source readings.
• targetOperators - list of ReadingOperators used for handling target readings.

Overrides: object.__init__

Converts a basic entity (e.g. a syllable) in the source reading to the given target reading.

This method is called by convertEntities() and a lower case entity is given for conversion. The returned value should be in lower case characters too, as convertEntities() will take care of capitalisation.

If a single entity needs to be converted it is recommended to use convertEntities() instead. In the general case it can not be ensured that a mapping from one reading to another can be done by the simple conversion of a basic entity. One-to-many mappings are possible and there is no guarantee that any entity of a reading recognised by operator.ReadingOperator.isReadingEntity() will be mapped here.

The default implementation will raise a NotImplementedError.

Parameters:

• entity - string written in the source reading in lower case letters
• fromReading - name of the source reading
• toReading - name of the target reading

Returns: str

the entity converted to the toReading in lower case

Raises:

• AmbiguousConversionError - if conversion for this entity of the source reading is ambiguous.
• ConversionError - on other operations specific to the conversion of the entity.
• InvalidEntityError - if the entity is invalid.

Overrides: EntityWiseReadingConverter.convertBasicEntity

(inherited documentation)

CONVERSION_DIRECTIONS

List of tuples for specifying supported conversion directions from reading A to reading B. If both directions are supported, two tuples (A, B) and (B, A) are given.

Value:

[('Jyutping', 'CantoneseYale'), ('CantoneseYale', 'Jyutping')]

DEFAULT_READING_OPTIONS

Defines default reading options for the reading used to convert from (to resp.) before (after resp.) converting to (from resp.) the user specified dialect.

The most general reading dialect should be specified as to allow for a broad range of input.

Value:

{'CantoneseYale': {'toneMarkType': 'Internal'}, 'Jyutping': {}}

DEFAULT_TONE_MAPPING

Mapping of Jyutping tones to Yale tones. Tone 1 needs to be handled independently.

Value:

{2: '2ndTone', 3: '3rdTone', 4: '4thTone', 5: '5thTone', 6: '6thTone'}