marytts.language.de.preprocess

Class TelephoneEP

java.lang.Object

marytts.language.de.preprocess.ExpansionPattern

marytts.language.de.preprocess.TelephoneEP

public class TelephoneEP
extends ExpansionPattern

An expansion pattern implementation for telephone number patterns.

Author:

Marc Schröder

Field Summary

Fields

Modifier and Type	Field and Description
protected Pattern	reTelephone
protected String	sMatchingChars
protected String	sTelephone

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
TelephoneEP() 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 s, int type) Subclasses do their expansion in this class.
protected List<Element>	expandTelephone(Document doc, List<Element> tokens) This method, differently from what is usually done, does not take a string argument, but the original tokens.
List<String>	knownTypes() Returns the types known by this ExpansionPattern.
protected int	match(String s, int type) Subclasses do their matching in this class.
protected boolean	matchTelephone(String s)
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, process, replaceTokens, reSplitAtChars, slowDown, slowDown

Methods inherited from class java.lang.Object

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

Field Detail

sTelephone

protected final String sTelephone

See Also:

Constant Field Values

sMatchingChars

protected final String sMatchingChars

See Also:

Constant Field Values

reTelephone

protected final Pattern reTelephone

Constructor Detail

TelephoneEP

public TelephoneEP()

Every subclass has its own logger. The important point is that if several threads are accessing the variable at the same telephone, 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

match

protected int match(String s,
        int type)

Description copied from class: ExpansionPattern

Subclasses do their matching in this class.

Specified by:

match in class ExpansionPattern

Parameters:

s - is the String to be matched,

type - 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 s,
                   int type)

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.

s - is the String to be expanded,

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

Returns:

the list of expanded (=new) tokens.

matchTelephone

protected boolean matchTelephone(String s)

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

expandTelephone

protected List<Element> expandTelephone(Document doc,
                            List<Element> tokens)

This method, differently from what is usually done, does not take a string argument, but the original tokens. The reason is that grouping of telephone number parts is often done using whitespace, information that would be lost if the whitespace-free string was used.

Parameters:

doc - doc

tokens - tokens

Returns:

exp