OpenJDK 1.22 · java.text.RBTableBuilder

This class contains all the code to parse a RuleBasedCollator pattern and build a RBCollationTables object from it. A particular instance of tis class exists only during the actual build process-- once an RBCollationTables object has been built, the RBTableBuilder object goes away. This object carries all of the state which is only needed during the build process, plus a "shadow" copy of all of the state that will go into the tables object itself. This object communicates with RBCollationTables through a separate class, RBCollationTables.BuildAPI, this is an inner class of RBCollationTables and provides a separate private API for communication with RBTableBuilder. This class isn't just an inner class of RBCollationTables itself because of its large size. For source-code readability, it seemed better for the builder to have its own source file.

Field Summary

Modifier and Type	Field and Description
pack-priv static final int	CHARINDEX
private IntHashtable	contractFlags
private Vector<Vector<EntryPair>>	contractTable
private Vector<int[]>	expandTable
private boolean	frenchSec
private static final int	IGNORABLEMASK
private static final int	INITIALTABLESIZE
private boolean	isOverIgnore
private char[]	keyBuf
private UCompactIntArray	mapping
private static final int	MAXKEYSIZE
private short	maxSecOrder
private short	maxTerOrder
private MergeCollation	mPattern
private static final int	PRIMARYORDERINCREMENT
private boolean	seAsianSwapping
private static final int	SECONDARYORDERINCREMENT
private RBCollationTables.BuildAPI	tables
private static final int	TERTIARYORDERINCREMENT

Constructor Summary

Access	Constructor and Description
public	RBTableBuilder(RBCollationTables.BuildAPI tables)

Method Summary

Modifier and Type	Method and Description
private void	addComposedChars() Add expanding entries for pre-composed unicode characters so that this collator can be used reasonably well with decomposition turned off.
private void	addContractFlags(String chars)
private final void	addContractOrder(String groupChars, int anOrder)
private final void	addContractOrder(String groupChars, int anOrder, boolean fwd) Adds the contracting string into the collation table.
private final void	addExpandOrder(String contractChars, String expandChars, int anOrder) Adds the expanding string into the collation table.
private final void	addExpandOrder(int ch, String expandChars, int anOrder)
private int	addExpansion(int anOrder, String expandChars) Create a new entry in the expansion table that contains the orderings for the given characters.
private final void	addOrder(int ch, int anOrder) Adds a character and its designated order into the collation table.
public void	build(String pattern, int decmp) Create a table-based collation object with the given rules.
private final void	commit() Look up for unmapped values in the expanded character table.
private final int	getCharOrder(int ch)
private int	getContractOrder(String groupChars) If the given string has been specified as a contracting string in this collation table, return its ordering.
private Vector<EntryPair>	getContractValues(int the starting character of the contracting string ch) Get the entry of hash table of the contracting string in the collation table.
private Vector<EntryPair>	getContractValuesImpl(int index)
private final int	increment(int aStrength, int lastValue) Increment of the last order based on the comparison level.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

CHARINDEX	back to summary
pack-priv static final int CHARINDEX

contractFlags	back to summary
private IntHashtable contractFlags

contractTable	back to summary
private Vector<Vector<EntryPair>> contractTable

expandTable	back to summary
private Vector<int[]> expandTable

frenchSec	back to summary
private boolean frenchSec

IGNORABLEMASK	back to summary
private static final int IGNORABLEMASK

INITIALTABLESIZE	back to summary
private static final int INITIALTABLESIZE

isOverIgnore	back to summary
private boolean isOverIgnore

keyBuf	back to summary
private char[] keyBuf

mapping	back to summary
private UCompactIntArray mapping

MAXKEYSIZE	back to summary
private static final int MAXKEYSIZE

maxSecOrder	back to summary
private short maxSecOrder

maxTerOrder	back to summary
private short maxTerOrder

mPattern	back to summary
private MergeCollation mPattern

PRIMARYORDERINCREMENT	back to summary
private static final int PRIMARYORDERINCREMENT

seAsianSwapping	back to summary
private boolean seAsianSwapping

SECONDARYORDERINCREMENT	back to summary
private static final int SECONDARYORDERINCREMENT

tables	back to summary
private RBCollationTables.BuildAPI tables

TERTIARYORDERINCREMENT	back to summary
private static final int TERTIARYORDERINCREMENT

Constructor Detail

RBTableBuilder	back to summary
public RBTableBuilder(RBCollationTables.BuildAPI tables)

Method Detail

addComposedChars	back to summary
private void addComposedChars() throws ParseException Add expanding entries for pre-composed unicode characters so that this collator can be used reasonably well with decomposition turned off.

addContractFlags	back to summary
private void addContractFlags(String chars)

addContractOrder	back to summary
private final void addContractOrder(String groupChars, int anOrder)

addContractOrder	back to summary
private final void addContractOrder(String groupChars, int anOrder, boolean fwd) Adds the contracting string into the collation table.

addExpandOrder	back to summary
private final void addExpandOrder(String contractChars, String expandChars, int anOrder) throws ParseException Adds the expanding string into the collation table.

addExpandOrder	back to summary
private final void addExpandOrder(int ch, String expandChars, int anOrder) throws ParseException

addExpansion	back to summary
private int addExpansion(int anOrder, String expandChars) Create a new entry in the expansion table that contains the orderings for the given characters. If anOrder is valid, it is added to the beginning of the expanded list of orders.

addOrder	back to summary
private final void addOrder(int ch, int anOrder) Adds a character and its designated order into the collation table.

build back to summary

build	back to summary
public void build(String pattern, int decmp) throws ParseException Create a table-based collation object with the given rules. This is the main function that actually builds the tables and stores them back in the RBCollationTables object. It is called ONLY by the RBCollationTables constructor. Exceptions ParseException: If the rules format is incorrect. See Also `RuleBasedCollator#RuleBasedCollator`

public void build(String pattern, int decmp) throws ParseException

Create a table-based collation object with the given rules. This is the main function that actually builds the tables and stores them back in the RBCollationTables object. It is called ONLY by the RBCollationTables constructor.

Exceptions

ParseException:: If the rules format is incorrect.

See Also

RuleBasedCollator#RuleBasedCollator

commit	back to summary
private final void commit() Look up for unmapped values in the expanded character table. When the expanding character tables are built by addExpandOrder, it doesn't know what the final ordering of each character in the expansion will be. Instead, it just puts the raw character code into the table, adding CHARINDEX as a flag. Now that we've finished building the mapping table, we can go back and look up that character to see what its real collation order is and stick that into the expansion table. That lets us avoid doing a two-stage lookup later.

commit

back to summary

private final void commit()

Look up for unmapped values in the expanded character table. When the expanding character tables are built by addExpandOrder, it doesn't know what the final ordering of each character in the expansion will be. Instead, it just puts the raw character code into the table, adding CHARINDEX as a flag. Now that we've finished building the mapping table, we can go back and look up that character to see what its real collation order is and stick that into the expansion table. That lets us avoid doing a two-stage lookup later.

getCharOrder	back to summary
private final int getCharOrder(int ch)

getContractOrder	back to summary
private int getContractOrder(String groupChars) If the given string has been specified as a contracting string in this collation table, return its ordering. Otherwise return UNMAPPED.

getContractValues	back to summary
private Vector<EntryPair> getContractValues(int ch) Get the entry of hash table of the contracting string in the collation table. Parameters ch:int the starting character of the contracting string

getContractValues

back to summary

private Vector<EntryPair> getContractValues(int ch)

Get the entry of hash table of the contracting string in the collation table.

Parameters

ch:int: the starting character of the contracting string

getContractValuesImpl	back to summary
private Vector<EntryPair> getContractValuesImpl(int index)