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.
SelectFormat for Gender AgreementNote
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}.
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.
| Modifier and Type | Field and Description |
|---|---|
| private transient MessagePattern | msgPattern
The MessagePattern which contains the parsed structure of the pattern string. |
| private String | |
| private static final long |
| Access | Constructor and Description |
|---|---|
| public | SelectFormat(String
the pattern for this pattern)SelectFormat.Creates a new |
| Modifier and Type | Method 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. |
| pack-priv static int | Returns: the sub-message start part index.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 | |
| public StringBuffer | Returns: the string buffer passed in as toAppendTo, with formatted text appended.a phrase selection keyword. keyword, StringBuffer the selected phrase will be appended to this
toAppendTo, FieldPosition StringBuffer.will be ignored by this method. pos)Implements abstract java. |
| public int | |
| public Object | Returns: nothing because this method is not supported.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. SelectFormat.
|
| private void | |
| private void | |
| public String | |
| public String |
| msgPattern | back to summary |
|---|---|
| private transient MessagePattern msgPattern The MessagePattern which contains the parsed structure of the pattern string. | |
| pattern | back to summary |
|---|---|
| private String pattern | |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| SelectFormat | back to summary |
|---|---|
| public SelectFormat(String pattern) Creates a new | |
| applyPattern | back 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.
| |
| equals | back to summary |
|---|---|
| public boolean equals(Object obj) Overrides java. Doc from java. Indicates whether some other object is "equal to" this one.
The
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. | |
| findSubMessage | back 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.
| |
| format | back to summary |
|---|---|
| public final String format(String keyword) Selects the phrase for the given keyword.
| |
| format | back to summary |
|---|---|
| public StringBuffer format(Object keyword, StringBuffer toAppendTo, FieldPosition pos) Implements abstract java. Selects the phrase for the given keyword.
and appends the formatted message to the given
| |
| hashCode | back to summary |
|---|---|
| public int hashCode() Overrides java. Doc from java. Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
The general contract of
| |
| parseObject | back to summary |
|---|---|
| public Object parseObject(String source, ParsePosition pos) Implements abstract java. This method is not supported by
| |
| readObject | back to summary |
|---|---|
| private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException | |
| reset | back to summary |
|---|---|
| private void reset() | |
| toPattern | back to summary |
|---|---|
| public String toPattern() Returns the pattern for this | |
| toString | back to summary |
|---|---|
| public String toString() Overrides java. Doc from java. Returns a string representation of the object. | |