Package com.aquima.interactions.framework.mask.impl

Class OrdinalNumber

java.lang.Object

com.aquima.interactions.framework.mask.impl.AbstractMask

com.aquima.interactions.framework.mask.impl.OrdinalNumber

All Implemented Interfaces:

IMask

public class OrdinalNumber
extends AbstractMask

Mask to create an ordinal number (dutch: rangtelwoord) for an integer value.

Example: IntegerValue(2) -> tweede

Notes:

• Values between 0 (included) and 100 (excluded) are supported, otherwise a SpellerOutOfRangeException is thrown.

Since:

6.0

Author:

Jon van Leuven

Constructor Summary

Constructors

Constructor	Description
OrdinalNumber(ISpellEngine spellEngine)	Construct a ordinal number mask.

Method Summary

Modifier and Type	Method	Description
protected String	applySingleValue(ISingleValue singleValue, IMaskContext context, ILanguage language)	This method is called when this mask is applied.
protected DataType[]	getValidDataTypes()	Should return the datatypes for which this mask can be applied.

Methods inherited from class com.aquima.interactions.framework.mask.impl.AbstractMask

apply

Methods inherited from class java.lang.Object

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

Constructor Details

OrdinalNumber

public OrdinalNumber(ISpellEngine spellEngine)

Construct a ordinal number mask.

Parameters:

spellEngine - Spell engine used for spelling ordinal numbers.

Method Details

applySingleValue

protected String applySingleValue(ISingleValue singleValue,
 IMaskContext context,
 ILanguage language)
                           throws Exception

Description copied from class: AbstractMask

This method is called when this mask is applied.

Specified by:

applySingleValue in class AbstractMask

Parameters:

singleValue - The value, never null and never unknown.

context - Mask context

Returns:

The applied mask result.

Throws:

Exception - When something went wrong.

getValidDataTypes

protected DataType[] getValidDataTypes()

Description copied from class: AbstractMask

Should return the datatypes for which this mask can be applied.

Specified by:

getValidDataTypes in class AbstractMask

Returns:

Array of datatypes.