Class JyutpingOperator

Creates an instance of the JyutpingOperator.

Parameters:

• options - extra options
• dbConnectInst - instance of a DatabaseConnector, if none is given, default settings will be assumed.
• strictSegmentation - if True segmentation (using segment()) and thus decomposition (using decompose()) will raise an exception if an alphabetic string is parsed which can not be segmented into single reading entities. If False the aforesaid string will be returned unsegmented.
• toneMarkType - if set to 'Numbers' the default form of appended numbers from 1 to 6 will be used to mark tones, if set to 'None' no tone marks will be used and no tonal information will be supplied at all.
• missingToneMark - if set to 'noinfo' no tone information will be deduced when no tone mark is found (takes on value None), if set to 'ignore' this entity will not be valid and for segmentation the behaviour defined by 'strictSegmentation' will take affect.

Overrides: object.__init__

Returns the reading operator's default options.

The default implementation returns an empty dictionary. The keyword 'dbConnectInst' is not regarded a configuration option of the operator and is thus not included in the dict returned.

Returns: dict

the reading operator's default options.

Overrides: ReadingOperator.getDefaultOptions

(inherited documentation)

Returns a set of tones supported by the reading. These tones don't necessarily reflect the tones of the underlying language but may defer to reflect notational or other features.

The default implementation will raise a NotImplementedError.

Returns: list

list of supported tone marks.

Overrides: TonalFixedEntityOperator.getTones

(inherited documentation)

Composes the given list of basic entities to a string.

The default implementation will raise a NotImplementedError.

Parameters:

• readingEntities - list of basic entities or other content

Returns: str

composed entities

Overrides: ReadingOperator.compose

(inherited documentation)

Gets the entity with tone mark for the given plain entity and tone.

The default implementation will raise a NotImplementedError.

Parameters:

• plainEntity - entity without tonal information
• tone - tone

Returns: str

entity with appropriate tone

Raises:

• InvalidEntityError - if the entity is invalid.
• UnsupportedError - if the operation is not supported for the given form.

Overrides: TonalFixedEntityOperator.getTonalEntity

(inherited documentation)

Splits the entity into an entity without tone mark (plain entity) and the entity's tone.

The default implementation will raise a NotImplementedError.

Parameters:

• entity - entity with tonal information

Returns: tuple

plain entity without tone mark and entity's tone

Raises:

• InvalidEntityError - if the entity is invalid.
• UnsupportedError - if the operation is not supported for the given form.

Overrides: TonalFixedEntityOperator.splitEntityTone

(inherited documentation)

Gets the list of plain entities supported by this reading. Different to getReadingEntities() the entities will carry no tone mark.

The default implementation will raise a NotImplementedError.

Returns: set of str

set of supported syllables

Overrides: TonalFixedEntityOperator.getPlainReadingEntities

(inherited documentation)

Splits the given plain syllable into onset (initial) and rhyme (final).

The syllabic nasals m, ng will be regarded as being finals.

Parameters:

• plainSyllable (str) - syllable without tone marks

Returns: tuple of str

tuple of entity onset and rhyme

Raises:

• InvalidEntityError - if the entity is invalid.