marytts.language.de.preprocess

Class CompositeEP

java.lang.Object

marytts.language.de.preprocess.ExpansionPattern

marytts.language.de.preprocess.CompositeEP

public class CompositeEP
extends ExpansionPattern

An expansion pattern implementation for composite patterns. Words consisting of digits and letters and pseudo-composites with a hyphen are split into their components. These will then need to be looked at by the other pattern expanders. CompositeEP directly overrides process(), and does not care about the usual subclass methods isCandidate(), match(), and expand().

Author:

Marc Schröder

Field Summary

Fields inherited from class marytts.language.de.preprocess.ExpansionPattern

abbrev, composite, currency, date, duration, measure, multiword, net, number, specialChar, telephone, time

Constructor Summary

Constructors

Constructor and Description
CompositeEP() Every subclass has its own logger.

Method Summary

Methods

Modifier and Type	Method and Description
protected int	canDealWith(String input, int typeCode) Decide whether we can expand a string according to type typeCode.
protected List<Element>	expand(List<Element> tokens, String text, int typeCode) Subclasses do their expansion in this class.
List<String>	knownTypes() Returns the types known by this ExpansionPattern.
protected int	match(String input, int typeCode) Subclasses do their matching in this class.
boolean	process(Element t, List<Element> expanded) Process this token.
Pattern	reMatchingChars() Returns the regular expression object matching any of the chars occurring in the pattern.

Methods inherited from class marytts.language.de.preprocess.ExpansionPattern

allowMultipleTokens, allPatterns, doesFullExpansion, getPattern, getSplitAtChars, isCandidate, makeNewTokens, makeNewTokens, makeNewTokens, match, replaceTokens, reSplitAtChars, slowDown, slowDown

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeEP

public CompositeEP()

Every subclass has its own logger. The important point is that if several threads are accessing the variable at the same time, the logger needs to be thread-safe or it will produce rubbish.

Method Detail

knownTypes

public List<String> knownTypes()

Description copied from class: ExpansionPattern

Returns the types known by this ExpansionPattern. These are possible values of the type attribute to the say-as element, as defined in MaryXML.dtd. Each subclass needs to override this to return something meaningful.

Specified by:

knownTypes in class ExpansionPattern

Returns:

known types

reMatchingChars

public Pattern reMatchingChars()

Description copied from class: ExpansionPattern

Returns the regular expression object matching any of the chars occurring in the pattern. Each subclass needs to override this to return something meaningful.

Specified by:

reMatchingChars in class ExpansionPattern

Returns:

reMatchingChars

process

public boolean process(Element t,
              List<Element> expanded)

Process this token. The CompositeEP works as a splitter of single tokens, iteratively expanding a token into its components.

Overrides:

process in class ExpansionPattern

Parameters:

t - the element to expand. After processing, this Element will still exist and be a valid Element, but possibly with a different content, and possibly enclosed by an <mtu> element. In addition, <t> may have new right-hand neighbours.

expanded - an empty list into which the expanded Elements are placed if an expansion occurred. The list will remain empty if no expansion was performed.

Returns:

true if this pattern is confident to have fully expanded this token, false if nothing could be done or more expansion may be necessary. CompositeEP always returns false, in order to have other ExpansionPatterns look at the components as well.

canDealWith

protected int canDealWith(String input,
              int typeCode)

Description copied from class: ExpansionPattern

Decide whether we can expand a string according to type typeCode. This is important in cases where a particular expansion is requested via a say-as element. As a default, reply that a string can be expanded if it would be matched by the pattern recogniser. Subclasses may wish to override this with less strict requirements. Returns the type as which it can be expanded, or -1 if expansion is not possible.

Specified by:

canDealWith in class ExpansionPattern

Parameters:

input - input

typeCode - typeCode

Returns:

true if it can deal with input and typecode

match

protected int match(String input,
        int typeCode)

Description copied from class: ExpansionPattern

Subclasses do their matching in this class.

Specified by:

match in class ExpansionPattern

Parameters:

input - is the String to be matched,

typeCode - is the index in knownTypes to match with.

Returns:

type actually matched on successful match with this type (if typeCode is a general type ( typeCode == 0), it may have matched with a more specific subtype). On failure, -1 is returned.

expand

protected List<Element> expand(List<Element> tokens,
                   String text,
                   int typeCode)

Description copied from class: ExpansionPattern

Subclasses do their expansion in this class.

Specified by:

expand in class ExpansionPattern

Parameters:

tokens - is a list of token Elements to be replaced with their expanded form. The expanded forms are inserted into the DOM tree at the same positions as the tokens in List tokens. If there are more new tokens than old tokens, the rest are inserted as siblings at the position of the last old token.

text - is the String to be expanded,

typeCode - is the index in knownTypes this string has matched with before.

Returns:

the list of expanded (=new) tokens.