edu.utah.bmi.rush.core

Class FastCRules

java.lang.Object

edu.utah.bmi.rush.core.FastCRules

public class FastCRules
extends Object

This class is an extension of FastRules. Instead of handling string-element rules, it handles char-element rules Wildcard definition:

( Beginning of capturing a group ) End of capturing a group

A punctuation

\ plus following characters + An addition symbol (to distinguish the "+" after a wildcard) ( A left parentheses symbol ) A right parentheses symbol d A digit C A capital letter c A lowercase letter s A whitespace a A Non-whitespace character u A unusual character: not a letter, not a number, not a punctuation, not a whitespace n A return

The wildcard plus "+": 1 or more wildcard

Author:

Jianlin Shi

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	debug
protected DeterminantValueSet.Determinants	END
protected int	maxRepeatLength
protected String	method
protected Matcher	mt
protected Pattern	pdigit
protected int	ruleId
protected HashMap	rules
protected HashMap<Integer,String>	ruleStore
protected HashMap<Integer,Double>	scores
protected boolean	scSupport
protected boolean	supportReplications

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FastCRules()
	FastCRules(String ruleFileName)

Method Summary

Modifier and Type	Method and Description
protected void	addDeterminants(HashMap rule, HashMap<DeterminantValueSet.Determinants,ArrayList<Span>> matches, int matchBegin, int matchEnd, int currentPosition, DeterminantValueSet.DirectionPrefer directionPrefer) if reaches the end of one or more rules, add all corresponding determinants into the results
protected boolean	addRule(char[] rule, DeterminantValueSet.Determinants determinant, double score) Override addRule method
protected boolean	compareScoreOnly(Span a, Span b)
protected boolean	compareScorePrior(Span a, Span b)
protected boolean	compareSpan(Span a, Span b)
protected boolean	compareWidthOnly(Span a, Span b)
protected boolean	compareWidthPrior(Span a, Span b)
String	getRuleString(int ruleId)
double	getScore(int ruleId)
protected void	initiate(String ruleFile) Read from ruleFile to construct the rules.
protected void	processRepetition(char[] textChars, HashMap rule, int matchBegin, int matchEnd, int currentPosition, HashMap<DeterminantValueSet.Determinants,ArrayList<Span>> matches, DeterminantValueSet.DirectionPrefer directionPrefer, char previousChar, boolean wildcard, char previousKey)
protected void	processRules(char[] textChars, HashMap rule, int matchBegin, int matchEnd, int currentPosition, HashMap<DeterminantValueSet.Determinants,ArrayList<Span>> matches, DeterminantValueSet.DirectionPrefer directionPrefer, char previousChar, boolean wildcard, char previousKey)
void	processRules(String text, HashMap<DeterminantValueSet.Determinants,ArrayList<Span>> matches, DeterminantValueSet.DirectionPrefer directionPrefer) Because the input parameters are different, this method is overridden.
protected void	processWildCards(char[] textChars, HashMap rule, int matchBegin, int matchEnd, int currentPosition, HashMap<DeterminantValueSet.Determinants,ArrayList<Span>> matches, DeterminantValueSet.DirectionPrefer directionPrefer, char previousChar) \d A digit \C A capital letter \c A lower case letter \s A whitespace \n A return \( Beginning of capturing a group \) End of capturing a group \p A punctuation \+ An addition symbol (to distinguish the "+" after a wildcard) The wildcard plus "+": 1 or more wildcard
void	setCompareMethod(String method)
void	setDebug(boolean debug)
void	setReplicationSupport(boolean support) Using "+" to support replications might slow down the performance of FastCRules, try to avoid using it as much as possible.
void	setScore(int ruleId, double score)
void	setSpecialCharacterSupport(Boolean scSupport)

Methods inherited from class java.lang.Object

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

Field Detail

scores

protected HashMap<Integer,Double> scores

ruleStore

protected HashMap<Integer,String> ruleStore

ruleId

protected int ruleId

END

protected final DeterminantValueSet.Determinants END

maxRepeatLength

protected final int maxRepeatLength

See Also:

Constant Field Values

supportReplications

protected boolean supportReplications

scSupport

protected boolean scSupport

debug

protected boolean debug

rules

protected HashMap rules

pdigit

protected Pattern pdigit

mt

protected Matcher mt

method

protected String method

Constructor Detail

FastCRules

protected FastCRules()

FastCRules

public FastCRules(String ruleFileName)

Method Detail

initiate

protected void initiate(String ruleFile)
                 throws IOException

Read from ruleFile to construct the rules. The Determinants (enum type) will be generated dynamically by read the last element of rule; The format of rule file (Using \t to separate):

chars score determinant

Parameters:

ruleFile - The path string of the rule file

Throws:

IOException

addRule

protected boolean addRule(char[] rule,
                          DeterminantValueSet.Determinants determinant,
                          double score)

Override addRule method

Parameters:

rule - A char array of rule

determinant - Specify which type of rule is this

score - Specify the priority score of this rule

Returns:

true: if the rule is added false: if the rule is a duplicate

processRules

public void processRules(String text,
                         HashMap<DeterminantValueSet.Determinants,ArrayList<Span>> matches,
                         DeterminantValueSet.DirectionPrefer directionPrefer)

Because the input parameters are different, this method is overridden.

Parameters:

text - The input text string

matches - Save the matched string in an ArrayList of Spans

directionPrefer - Specify the preference of directions

processRules

protected void processRules(char[] textChars,
                            HashMap rule,
                            int matchBegin,
                            int matchEnd,
                            int currentPosition,
                            HashMap<DeterminantValueSet.Determinants,ArrayList<Span>> matches,
                            DeterminantValueSet.DirectionPrefer directionPrefer,
                            char previousChar,
                            boolean wildcard,
                            char previousKey)

Parameters:

textChars - Input string in the format of character array

rule - The constructed rules Map for processing

matchBegin - Store the beginning position of matching

matchEnd - Store the ending position of matching

currentPosition - Store the current position of matching

matches - Save the matched string in an ArrayList of Spans

directionPrefer - Specify the preference of directions

previousChar - Store the previous character for wildcard matching use

wildcard - Whether wildcard is enabled

previousKey - Store the previous previous matched character for replication detection use

processRepetition

protected void processRepetition(char[] textChars,
                                 HashMap rule,
                                 int matchBegin,
                                 int matchEnd,
                                 int currentPosition,
                                 HashMap<DeterminantValueSet.Determinants,ArrayList<Span>> matches,
                                 DeterminantValueSet.DirectionPrefer directionPrefer,
                                 char previousChar,
                                 boolean wildcard,
                                 char previousKey)

Parameters:

textChars - Input string in the format of character array

rule - The constructed rules Map for processing

matchBegin - Store the beginning position of matching

matchEnd - Store the ending position of matching

currentPosition - Store the current position of matching

matches - Save the matched string in an ArrayList of Spans

directionPrefer - Specify the preference of directions

previousChar - Store the previous character for wildcard matching use

wildcard - Whether wildcard is enabled

previousKey - Store the previous previous matched character for replication detection use

processWildCards

protected void processWildCards(char[] textChars,
                                HashMap rule,
                                int matchBegin,
                                int matchEnd,
                                int currentPosition,
                                HashMap<DeterminantValueSet.Determinants,ArrayList<Span>> matches,
                                DeterminantValueSet.DirectionPrefer directionPrefer,
                                char previousChar)

\d A digit \C A capital letter \c A lower case letter \s A whitespace \n A return \( Beginning of capturing a group \) End of capturing a group \p A punctuation \+ An addition symbol (to distinguish the "+" after a wildcard) The wildcard plus "+": 1 or more wildcard

Parameters:

textChars - Input string in the format of character array

rule - The constructed rules Map for processing

matchBegin - Store the beginning position of matching

matchEnd - Store the ending position of matching

currentPosition - Store the current position of matching

matches - Save the matched string in an ArrayList of Spans

directionPrefer - Specify the preference of directions

addDeterminants

protected void addDeterminants(HashMap rule,
                               HashMap<DeterminantValueSet.Determinants,ArrayList<Span>> matches,
                               int matchBegin,
                               int matchEnd,
                               int currentPosition,
                               DeterminantValueSet.DirectionPrefer directionPrefer)

if reaches the end of one or more rules, add all corresponding determinants into the results

The priority of multiple applicable rules can be modified. This version uses the following three rules: 1. if determinant spans overlap, choose the determinant with the widest span 2. else if prefer right determinant, choose the determinant with the largest end. 3. else if prefer left determinant, choose the determinant with the smallest begin.

Parameters:

rule - The constructed rules Map for processing

matches - Save the matched string in an ArrayList of Spans

matchBegin - Store the beginning position of matching

matchEnd - Store the ending position of matching

currentPosition - Store the current position of matching

directionPrefer - Specify the preference of directions

getScore

public double getScore(int ruleId)

setScore

public void setScore(int ruleId,
                     double score)

setReplicationSupport

public void setReplicationSupport(boolean support)

Using "+" to support replications might slow down the performance of FastCRules, try to avoid using it as much as possible.

Parameters:

support - Whether support replication grammar

setCompareMethod

public void setCompareMethod(String method)

compareScoreOnly

protected boolean compareScoreOnly(Span a,
                                   Span b)

compareWidthOnly

protected boolean compareWidthOnly(Span a,
                                   Span b)

compareScorePrior

protected boolean compareScorePrior(Span a,
                                    Span b)

compareWidthPrior

protected boolean compareWidthPrior(Span a,
                                    Span b)

compareSpan

protected boolean compareSpan(Span a,
                              Span b)

setSpecialCharacterSupport

public void setSpecialCharacterSupport(Boolean scSupport)

setDebug

public void setDebug(boolean debug)

getRuleString

public String getRuleString(int ruleId)