Package com.aquima.interactions.ds

Class LanguageFormatDefinition

java.lang.Object

com.aquima.interactions.ds.LanguageFormatDefinition

All Implemented Interfaces:

Serializable

public class LanguageFormatDefinition
extends Object
implements Serializable

This class contains a mapping between a data type and a value format that should be used for that type. The mapping may also contain a language code, indicating that this mapping is only applicable for the specified language.

Since:

7.0

Author:

O. Kerpershoek

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
LanguageFormatDefinition(String type, String formatName)	Constructs the type mapping with the required arguments.
LanguageFormatDefinition(String type, String formatName, String languageCode)	Constructs the type mapping with the required arguments.

Method Summary

Modifier and Type	Method	Description
String	getFormatName()	This method returns the name of the value format the type is mapped to.
String	getLanguageCode()	This method returns the language code the mapping was defined for.
DataType	getType()	This method returns the type the format should be mapped to.
boolean	isDefaultMapping()	This method returns a boolean indicating if this type mapping may be used as default when no specific mapping can be found for a language.

Methods inherited from class java.lang.Object

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

Constructor Details

LanguageFormatDefinition

public LanguageFormatDefinition(String type,
 String formatName)

Constructs the type mapping with the required arguments.

Parameters:

type - The name of the data type the mapping is defined for.

formatName - The name of the value format that should be used for the type.

LanguageFormatDefinition

public LanguageFormatDefinition(String type,
 String formatName,
 String languageCode)

Constructs the type mapping with the required arguments.

Parameters:

type - The name of the data type the mapping is defined for.

formatName - The name of the value format that should be used for the type.

languageCode - The code of the language for which this mapping is defined (optional).

Method Details

getType

public DataType getType()

This method returns the type the format should be mapped to.

Returns:

the type the format should be mapped to.

getFormatName

public String getFormatName()

This method returns the name of the value format the type is mapped to.

Returns:

the name of the value format the type is mapped to.

getLanguageCode

public String getLanguageCode()

This method returns the language code the mapping was defined for. The language code of a mapping is optional in the configuration, so this method may return null.

Returns:

the language code the mapping was defined for.

isDefaultMapping

public boolean isDefaultMapping()

This method returns a boolean indicating if this type mapping may be used as default when no specific mapping can be found for a language.

Returns:

Boolean indicating if this type mapping may be used as default when no specific mapping can be found for a language.