Top Description Fields Constructors Methods
com.ibm.icu.text

public Class SelectFormat

extends Format
Class Inheritance
Imports
java.io.IOException, .ObjectInputStream, java.text.FieldPosition, .Format, .ParsePosition, com.ibm.icu.impl.PatternProps

SelectFormat supports the creation of internationalized messages by selecting phrases based on keywords. The pattern specifies how to map keywords to phrases and provides a default phrase. The object provided to the format method is a string that's matched against the keywords. If there is a match, the corresponding phrase is selected; otherwise, the default phrase is used.

Using SelectFormat for Gender Agreement

Note

Typically, select formatting is done via MessageFormat with a select argument type, rather than using a stand-alone SelectFormat.

The main use case for the select format is gender based inflection. When names or nouns are inserted into sentences, their gender can affect pronouns, verb forms, articles, and adjectives. Special care needs to be taken for the case where the gender cannot be determined. The impact varies between languages:

Some other languages have noun classes that are not related to gender, but similar in grammatical use. Some African languages have around 20 noun classes.

Note

For the gender of a person in a given sentence, we usually need to distinguish only between female, male and other/unknown.

To enable localizers to create sentence patterns that take their language's gender dependencies into consideration, software has to provide information about the gender associated with a noun or name to MessageFormat. Two main cases can be distinguished:

The resulting keyword is provided to MessageFormat as a parameter separate from the name or noun it's associated with. For example, to generate a message such as "Jean went to Paris", three separate arguments would be provided: The name of the person as argument 0, the gender of the person as argument 1, and the name of the city as argument 2. The sentence pattern for English, where the gender of the person has no impact on this simple sentence, would not refer to argument 1 at all:

{0} went to {2}.

Note

The entire sentence should be included (and partially repeated) inside each phrase. Otherwise translators would have to be trained on how to move bits of the sentence in and out of the select argument of a message. (The examples below do not follow this recommendation!)

The sentence pattern for French, where the gender of the person affects the form of the participle, uses a select format based on argument 1:

{0} est {1, select, female {allée} other {allé}} à {2}.

Patterns can be nested, so that it's possible to handle interactions of number and gender where necessary. For example, if the above sentence should allow for the names of several people to be inserted, the following sentence pattern can be used (with argument 0 the list of people's names, argument 1 the number of people, argument 2 their combined gender, and argument 3 the city name):

{0} {1, plural, 
one {est {2, select, female {allée} other  {allé}}}
other {sont {2, select, female {allées} other {allés}}}
}à {3}.

Patterns and Their Interpretation

The SelectFormat pattern string defines the phrase output for each user-defined keyword. The pattern is a sequence of (keyword, message) pairs. A keyword is a "pattern identifier": [^[[:Pattern_Syntax:][:Pattern_White_Space:]]]+

Each message is a MessageFormat pattern string enclosed in {curly braces}.

You always have to define a phrase for the default keyword other; this phrase is returned when the keyword provided to the format method matches no other keyword. If a pattern does not provide a phrase for other, the method it's provided to returns the error U_DEFAULT_KEYWORD_MISSING.
Pattern_White_Space between keywords and messages is ignored. Pattern_White_Space within a message is preserved and output.

Example:
MessageFormat msgFmt = new MessageFormat("{0} est " +
    "{1, select, female {allée} other {allé}} à Paris.",
    new ULocale("fr"));
Object args[] = {"Kirti","female"};
System.out.println(msgFmt.format(args));

Produces the output:
Kirti est allée à Paris.

ICU Status
Stable since ICU 4.4.

Field Summary

Modifier and TypeField and Description
private transient MessagePattern
msgPattern

The MessagePattern which contains the parsed structure of the pattern string.

private String
private static final long

Constructor Summary

AccessConstructor and Description
public
SelectFormat(String
the pattern for this SelectFormat.
pattern
)

Creates a new SelectFormat for a given pattern string.

Method Summary

Modifier and TypeMethod and Description
public void
applyPattern(String
the pattern for this select format.
pattern
)

Sets the pattern used by this select format.

public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
pack-priv static int

Returns:

the sub-message start part index.
findSubMessage
(MessagePattern
A MessagePattern.
pattern
,
int
the index of the first SelectFormat argument style part.
partIndex
,
String
a keyword to be matched to one of the SelectFormat argument's keywords.
keyword
)

Finds the SelectFormat sub-message for the given keyword, or the "other" sub-message.

public final String

Returns:

the string containing the formatted select message.
format
(String
a phrase selection keyword.
keyword
)

Selects the phrase for the given keyword.

public StringBuffer

Returns:

the string buffer passed in as toAppendTo, with formatted text appended.
format
(Object
a phrase selection keyword.
keyword
,
StringBuffer
the selected phrase will be appended to this StringBuffer.
toAppendTo
,
FieldPosition
will be ignored by this method.
pos
)

Implements abstract java.text.Format.format.

Selects the phrase for the given keyword.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public Object

Returns:

nothing because this method is not supported.
parseObject
(String
the string to be parsed.
source
,
ParsePosition
defines the position where parsing is to begin, and upon return, the position where parsing left off. If the position has not changed upon return, then parsing failed.
pos
)

Implements abstract java.text.Format.parseObject.

This method is not supported by SelectFormat.
private void
private void
public String

Returns:

the pattern string
toPattern
()

Returns the pattern for this SelectFormat

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.text.Format:
cloneformatformatToCharacterIteratorparseObject

Field Detail

msgPatternback to summary
private transient MessagePattern msgPattern

The MessagePattern which contains the parsed structure of the pattern string.

patternback to summary
private String pattern
serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.text.Format.serialVersionUID.

Constructor Detail

SelectFormatback to summary
public SelectFormat(String pattern)

Creates a new SelectFormat for a given pattern string.

Parameters
pattern:String

the pattern for this SelectFormat.

ICU Status
Stable since ICU 4.4.

Method Detail

applyPatternback to summary
public void applyPattern(String pattern)

Sets the pattern used by this select format. Patterns and their interpretation are specified in the class description.

Parameters
pattern:String

the pattern for this select format.

Exceptions
IllegalArgumentException:
when the pattern is not a valid select format pattern.
ICU Status
Stable since ICU 4.4.
equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
ICU Status
Stable since ICU 4.4.
findSubMessageback to summary
pack-priv static int findSubMessage(MessagePattern pattern, int partIndex, String keyword)

Finds the SelectFormat sub-message for the given keyword, or the "other" sub-message.

Parameters
pattern:MessagePattern

A MessagePattern.

partIndex:int

the index of the first SelectFormat argument style part.

keyword:String

a keyword to be matched to one of the SelectFormat argument's keywords.

Returns:int

the sub-message start part index.

formatback to summary
public final String format(String keyword)

Selects the phrase for the given keyword.

Parameters
keyword:String

a phrase selection keyword.

Returns:String

the string containing the formatted select message.

Exceptions
IllegalArgumentException:
when the given keyword is not a "pattern identifier"
ICU Status
Stable since ICU 4.4.
formatback to summary
public StringBuffer format(Object keyword, StringBuffer toAppendTo, FieldPosition pos)

Implements abstract java.text.Format.format.

Selects the phrase for the given keyword. and appends the formatted message to the given StringBuffer.

Parameters
keyword:Object

a phrase selection keyword.

toAppendTo:StringBuffer

the selected phrase will be appended to this StringBuffer.

pos:FieldPosition

will be ignored by this method.

Returns:StringBuffer

the string buffer passed in as toAppendTo, with formatted text appended.

Exceptions
IllegalArgumentException:
when the given keyword is not a String or not a "pattern identifier"
ICU Status
Stable since ICU 4.4.
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
ICU Status
Stable since ICU 4.4.
parseObjectback to summary
public Object parseObject(String source, ParsePosition pos)

Implements abstract java.text.Format.parseObject.

This method is not supported by SelectFormat.

Parameters
source:String

the string to be parsed.

pos:ParsePosition

defines the position where parsing is to begin, and upon return, the position where parsing left off. If the position has not changed upon return, then parsing failed.

Returns:Object

nothing because this method is not supported.

Exceptions
UnsupportedOperationException:
thrown always.
ICU Status
Stable since ICU 4.4.
readObjectback to summary
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException
resetback to summary
private void reset()
toPatternback to summary
public String toPattern()

Returns the pattern for this SelectFormat

Returns:String

the pattern string

ICU Status
Stable since ICU 4.4.
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
ICU Status
Stable since ICU 4.4.