Class MFDataModelFormatter

java.lang.Object

com.ibm.icu.message2.MFDataModelFormatter

class MFDataModelFormatter
extends Object

Takes an MFDataModel and formats it to a String (and later on we will also implement formatting to a FormattedMessage).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	MFDataModelFormatter.IntVarTuple
private static class	MFDataModelFormatter.MapWithNfcKeys
(package private) static class	MFDataModelFormatter.ResolvedExpression
private static class	MFDataModelFormatter.ResolvedSelector

Field Summary

Fields

Modifier and Type	Field	Description
private final MessageFormatter.BidiIsolation	bidiIsolation
private final MFFunctionRegistry	customFunctions
private final MFDataModel.Message	dm
private static final MFFunctionRegistry	EMPTY_REGISTY
private final MessageFormatter.ErrorHandlingBehavior	errorHandlingBehavior
private static final char	FSI
private final Locale	locale
private static final char	LRI
private static final char	PDI
private static final char	RLI
private final MFFunctionRegistry	standardFunctions

Constructor Summary

Constructors

Constructor	Description
MFDataModelFormatter(MFDataModel.Message dm, Locale locale, MessageFormatter.ErrorHandlingBehavior errorHandlingBehavior, MessageFormatter.BidiIsolation bidiIsolation, MFFunctionRegistry customFunctionRegistry)

Method Summary

Modifier and Type	Method	Description
private static MFDataModelFormatter.MapWithNfcKeys	convertOptions(Map<String, MFDataModel.Option> options, MFDataModelFormatter.MapWithNfcKeys localVars, MFDataModelFormatter.MapWithNfcKeys arguments)
private static void	fatalFormattingError(String message)
private MFDataModel.Pattern	findBestMatchingPattern(MFDataModel.SelectMessage sm, MFDataModelFormatter.MapWithNfcKeys variables, MFDataModelFormatter.MapWithNfcKeys arguments)
(package private) String	format(Map<String,Object> arguments)
private FormattedPlaceholder	formatExpression(MFDataModel.Expression expression, MFDataModelFormatter.MapWithNfcKeys variables, MFDataModelFormatter.MapWithNfcKeys arguments)	Formats an expression.
private FunctionFactory	getFormattingFunctionFactoryByName(Object toFormat, String functionName)
private void	implementBiDiDefault(StringBuilder result, Directionality msgdir, FormattedPlaceholder formattedExpression)
private List<String>	matchSelectorKeys(MFDataModelFormatter.ResolvedSelector rv, List<String> keys)	spec: The method MatchSelectorKeys is determined by the implementation.
private MFDataModelFormatter.MapWithNfcKeys	resolveDeclarations(List<MFDataModel.Declaration> declarations, MFDataModelFormatter.MapWithNfcKeys arguments)
private static Object	resolveLiteralOrVariable(MFDataModel.LiteralOrVariableRef value, MFDataModelFormatter.MapWithNfcKeys localVars, MFDataModelFormatter.MapWithNfcKeys arguments)
private static int	sortVariants(MFDataModelFormatter.IntVarTuple o1, MFDataModelFormatter.IntVarTuple o2)

Methods inherited from class Object

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

Field Details

LRI

private static final char LRI

See Also:

• Constant Field Values

RLI

private static final char RLI

See Also:

• Constant Field Values

FSI

private static final char FSI

See Also:

• Constant Field Values

PDI

private static final char PDI

See Also:

• Constant Field Values

locale

private final Locale locale

errorHandlingBehavior

private final MessageFormatter.ErrorHandlingBehavior errorHandlingBehavior

bidiIsolation

private final MessageFormatter.BidiIsolation bidiIsolation

dm

private final MFDataModel.Message dm

standardFunctions

private final MFFunctionRegistry standardFunctions

customFunctions

private final MFFunctionRegistry customFunctions

EMPTY_REGISTY

private static final MFFunctionRegistry EMPTY_REGISTY

Constructor Details

MFDataModelFormatter

MFDataModelFormatter(MFDataModel.Message dm,
 Locale locale,
 MessageFormatter.ErrorHandlingBehavior errorHandlingBehavior,
 MessageFormatter.BidiIsolation bidiIsolation,
 MFFunctionRegistry customFunctionRegistry)

Method Details

format

String format(Map<String,Object> arguments)

implementBiDiDefault

private void implementBiDiDefault(StringBuilder result,
 Directionality msgdir,
 FormattedPlaceholder formattedExpression)

findBestMatchingPattern

private MFDataModel.Pattern findBestMatchingPattern(MFDataModel.SelectMessage sm,
 MFDataModelFormatter.MapWithNfcKeys variables,
 MFDataModelFormatter.MapWithNfcKeys arguments)

sortVariants

private static int sortVariants(MFDataModelFormatter.IntVarTuple o1,
 MFDataModelFormatter.IntVarTuple o2)

matchSelectorKeys

private List<String> matchSelectorKeys(MFDataModelFormatter.ResolvedSelector rv,
 List<String> keys)

spec: The method MatchSelectorKeys is determined by the implementation. It takes as arguments a resolved _selector_ value `rv` and a list of string keys `keys`, and returns a list of string keys in preferential order. The returned list MUST contain only unique elements of the input list `keys`. The returned list MAY be empty. The most-preferred key is first, with each successive key appearing in order by decreasing preference.

fatalFormattingError

private static void fatalFormattingError(String message)
                                  throws IllegalArgumentException

Throws:

IllegalArgumentException

getFormattingFunctionFactoryByName

private FunctionFactory getFormattingFunctionFactoryByName(Object toFormat,
 String functionName)

resolveLiteralOrVariable

private static Object resolveLiteralOrVariable(MFDataModel.LiteralOrVariableRef value,
 MFDataModelFormatter.MapWithNfcKeys localVars,
 MFDataModelFormatter.MapWithNfcKeys arguments)

convertOptions

private static MFDataModelFormatter.MapWithNfcKeys convertOptions(Map<String, MFDataModel.Option> options,
 MFDataModelFormatter.MapWithNfcKeys localVars,
 MFDataModelFormatter.MapWithNfcKeys arguments)

formatExpression

private FormattedPlaceholder formatExpression(MFDataModel.Expression expression,
 MFDataModelFormatter.MapWithNfcKeys variables,
 MFDataModelFormatter.MapWithNfcKeys arguments)

Formats an expression.

Parameters:

expression - the expression to format

variables - local variables, created from declarations (`.input` and `.local`)

arguments - the arguments passed at runtime to be formatted (`mf.format(arguments)`)

resolveDeclarations

private MFDataModelFormatter.MapWithNfcKeys resolveDeclarations(List<MFDataModel.Declaration> declarations,
 MFDataModelFormatter.MapWithNfcKeys arguments)