Class Rule
java.lang.Object
org.apache.commons.codec.language.bm.Rule
A phoneme rule.
Rules have a pattern, left context, right context, output phoneme, set of languages for which they apply and a logical flag indicating if all languages must be in play. A rule matches if:
- the pattern matches at the current position
- the string up until the beginning of the pattern matches the left context
- the string from the end of the pattern matches the right context
- logical is ALL and all languages are in scope; or
- logical is any other value and at least one language is in scope
Rules are typically generated by parsing rules resources. In normal use, there will be no need for the user to explicitly construct their own.
Rules are immutable and thread-safe.
Rules resources
Rules are typically loaded from resource files. These are UTF-8 encoded text files. They are systematically named following the pattern:
org/apache/commons/codec/language/bm/${NameType#getName}_${RuleType#getName}_${language}.txt
The format of these resources is the following:
- Rules: whitespace separated, double-quoted strings. There should be 4 columns to each row, and these
will be interpreted as:
- pattern
- left context
- right context
- phoneme
- End-of-line comments: Any occurrence of '//' will cause all text following on that line to be discarded as a comment.
- Multi-line comments: Any line starting with '/*' will start multi-line commenting mode. This will skip all content until a line ending in '*' and '/' is found.
- Blank lines: All blank lines will be skipped.
- Since:
- 1.6
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
static interface
static final class
static interface
A minimal wrapper around the functionality of Pattern that we use, to allow for alternate implementations. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final Rule.RPattern
private static final String
private static final String
private static final int
private final Rule.RPattern
private final String
private final Rule.PhonemeExpr
private final Rule.RPattern
-
Constructor Summary
ConstructorsConstructorDescriptionRule
(String pattern, String lContext, String rContext, Rule.PhonemeExpr phoneme) Creates a new rule. -
Method Summary
Modifier and TypeMethodDescriptionprivate static boolean
contains
(CharSequence chars, char input) private static String
createResourceName
(NameType nameType, RuleType rt, String lang) private static Scanner
createScanner
(String lang) private static Scanner
createScanner
(NameType nameType, RuleType rt, String lang) private static boolean
endsWith
(CharSequence input, CharSequence suffix) getInstance
(NameType nameType, RuleType rt, String lang) Gets rules for a combination of name type, rule type and a single language.getInstance
(NameType nameType, RuleType rt, Languages.LanguageSet langs) Gets rules for a combination of name type, rule type and languages.getInstanceMap
(NameType nameType, RuleType rt, String lang) Gets rules for a combination of name type, rule type and a single language.getInstanceMap
(NameType nameType, RuleType rt, Languages.LanguageSet langs) Gets rules for a combination of name type, rule type and languages.Gets the left context.Gets the pattern.Gets the phoneme.Gets the right context.private static Rule.Phoneme
parsePhoneme
(String ph) private static Rule.PhonemeExpr
parseRules
(Scanner scanner, String location) private static Rule.RPattern
Attempts to compile the regex into direct string ops, falling back to Pattern and Matcher in the worst case.boolean
patternAndContextMatches
(CharSequence input, int i) Decides if the pattern and context match the input starting at a position.private static boolean
startsWith
(CharSequence input, CharSequence prefix) private static String
stripQuotes
(String str)
-
Field Details
-
ALL_STRINGS_RMATCHER
-
ALL
- See Also:
-
DOUBLE_QUOTE
- See Also:
-
HASH_INCLUDE
- See Also:
-
HASH_INCLUDE_LENGTH
private static final int HASH_INCLUDE_LENGTH -
RULES
-
lContext
-
pattern
-
phoneme
-
rContext
-
-
Constructor Details
-
Rule
Creates a new rule.- Parameters:
pattern
- the patternlContext
- the left contextrContext
- the right contextphoneme
- the resulting phoneme
-
-
Method Details
-
contains
-
createResourceName
-
createScanner
-
createScanner
-
endsWith
-
getInstance
Gets rules for a combination of name type, rule type and languages.- Parameters:
nameType
- the NameType to considerrt
- the RuleType to considerlangs
- the set of languages to consider- Returns:
- a list of Rules that apply
-
getInstance
Gets rules for a combination of name type, rule type and a single language.- Parameters:
nameType
- the NameType to considerrt
- the RuleType to considerlang
- the language to consider- Returns:
- a list of Rules that apply
-
getInstanceMap
public static Map<String,List<Rule>> getInstanceMap(NameType nameType, RuleType rt, Languages.LanguageSet langs) Gets rules for a combination of name type, rule type and languages.- Parameters:
nameType
- the NameType to considerrt
- the RuleType to considerlangs
- the set of languages to consider- Returns:
- a map containing all Rules that apply, grouped by the first character of the rule pattern
- Since:
- 1.9
-
getInstanceMap
Gets rules for a combination of name type, rule type and a single language.- Parameters:
nameType
- the NameType to considerrt
- the RuleType to considerlang
- the language to consider- Returns:
- a map containing all Rules that apply, grouped by the first character of the rule pattern
- Since:
- 1.9
-
parsePhoneme
-
parsePhonemeExpr
-
parseRules
-
pattern
Attempts to compile the regex into direct string ops, falling back to Pattern and Matcher in the worst case.- Parameters:
regex
- the regular expression to compile- Returns:
- an RPattern that will match this regex
-
startsWith
-
stripQuotes
-
getLContext
Gets the left context. This is a regular expression that must match to the left of the pattern.- Returns:
- the left context Pattern
-
getPattern
Gets the pattern. This is a string-literal that must exactly match.- Returns:
- the pattern
-
getPhoneme
Gets the phoneme. If the rule matches, this is the phoneme associated with the pattern match.- Returns:
- the phoneme
-
getRContext
Gets the right context. This is a regular expression that must match to the right of the pattern.- Returns:
- the right context Pattern
-
patternAndContextMatches
Decides if the pattern and context match the input starting at a position. It is a match if thelContext
matchesinput
up toi
,pattern
matches at i andrContext
matches from the end of the match ofpattern
to the end ofinput
.- Parameters:
input
- the input Stringi
- the int position within the input- Returns:
- true if the pattern and left/right context match, false otherwise
-