ilog.views.util.text

Class IlvPatternBasedListFormat

java.lang.Object

ilog.views.util.text.IlvListFormat

ilog.views.util.text.IlvPatternBasedListFormat

public class IlvPatternBasedListFormat
extends IlvListFormat

This class formats a list of items, producing a single string. It does so by using a small number of format strings (patterns).

The main patterns are called the "start format", the "mid format", and the "end format".

• The end format is used to combine the second-to-last element and the last element. It is applied first.
• The middle format is used to combine an element other than the first and the second-to-last with the already constructed list of the elements that follow it. It is applied multiple times.
• The start format is used to combine the first element with the already constructed list of the elements that follow it. It is applied once.

For example, in order to format a list with five elements a, b, c, d, e, the format strings are applied like this: start(a,middle(b,middle(c,end(d,e)))).

For the special cases of up to two elements, special format strings are used:

• The two-elements format.
• The one-element format.
• The zero-elements string. This is a literal string, not a pattern.

Note: This class may be obsoleted once the corresponding support is added to the International Components for Unicode library.

Since:

JViews 8.7

Field Summary

Fields inherited from class ilog.views.util.text.IlvListFormat

LONG, SHORT

Constructor Summary

Constructors

Constructor and Description
IlvPatternBasedListFormat() Deprecated. Since JViews 8.7, please use the constructor IlvPatternBasedListFormat(Locale) instead, passing a locale explicitly - usually either IlvLocaleUtil.getCurrentLocale() or IlvLocaleUtil.getServerLocale().
IlvPatternBasedListFormat(Locale locale) Creates a list formatter, based on a separator string suitable for the given locale.
IlvPatternBasedListFormat(String endFormatString, String middleFormatString, String startFormatString, String twoElementsFormatString, String oneElementFormatString, String zeroElementsString) Creates a list formatter, based on the given format strings (patterns).

Method Summary

Modifier and Type	Method and Description
String	format(String[] elements) Returns the string that expresses the given elements, in order.
String	getEndFormatString() Returns the pattern that formats the part of the last two elements.
String	getMiddleFormatString() Returns the pattern that combines an element (other than the first element) with the part that already combines the elements that follow it.
String	getOneElementFormatString() Returns the pattern that formats a list of a single element.
String	getStartFormatString() Returns the pattern that combines the first element with the part that already combines the elements that follow it.
String	getTwoElementsFormatString() Returns the pattern that formats a list of two elements.
String	getZeroElementsString() Returns the string that represents a list of zero elements.

Methods inherited from class ilog.views.util.text.IlvListFormat

getInstance, getInstance, getInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvPatternBasedListFormat

@Deprecated
public IlvPatternBasedListFormat()

Deprecated. Since JViews 8.7, please use the constructor IlvPatternBasedListFormat(Locale) instead, passing a locale explicitly - usually either IlvLocaleUtil.getCurrentLocale() or IlvLocaleUtil.getServerLocale().

Creates a list formatter, based on a separator string suitable for the default locale.

See Also:

Locale.getDefault()

IlvPatternBasedListFormat

public IlvPatternBasedListFormat(Locale locale)

Creates a list formatter, based on a separator string suitable for the given locale.

IlvPatternBasedListFormat

public IlvPatternBasedListFormat(String endFormatString,
                                 String middleFormatString,
                                 String startFormatString,
                                 String twoElementsFormatString,
                                 String oneElementFormatString,
                                 String zeroElementsString)

Creates a list formatter, based on the given format strings (patterns).

Parameters:

endFormatString - The pattern that formats the part of the last two elements. This must be a format string that takes two arguments.

middleFormatString - The pattern that combines an element (other than the first element) with the part that already combines the elements that follow it. This must be a format string that takes two arguments.

startFormatString - The pattern that combines the first element with the part that already combines the elements that follow it. This must be a format string that takes two arguments.

twoElementsFormatString - The pattern that formats a list of two elements. This must be a format string that takes two arguments.

oneElementFormatString - The pattern that formats a list of a single element. This must be a format string that takes one argument.

zeroElementsString - The string that represents a list of zero elements. This must be a literal string, not a format string.

Method Detail

getZeroElementsString

public String getZeroElementsString()

Returns the string that represents a list of zero elements.

getOneElementFormatString

public String getOneElementFormatString()

Returns the pattern that formats a list of a single element.

getTwoElementsFormatString

public String getTwoElementsFormatString()

Returns the pattern that formats a list of two elements.

getEndFormatString

public String getEndFormatString()

Returns the pattern that formats the part of the last two elements.

getMiddleFormatString

public String getMiddleFormatString()

Returns the pattern that combines an element (other than the first element) with the part that already combines the elements that follow it.

getStartFormatString

public String getStartFormatString()

Returns the pattern that combines the first element with the part that already combines the elements that follow it.

format

public String format(String[] elements)

Returns the string that expresses the given elements, in order. For example, in an English locale, when the elements "a", "b", "c" are given, this may return the string "a, b, and c".

Specified by:

format in class IlvListFormat

Parameters:

elements - An array of strings.

Returns:

A single string containing the elements as substrings in the given order.