Package org.languagetool.rules.patterns

Class PatternRuleHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.languagetool.rules.patterns.XMLRuleHandler

org.languagetool.rules.patterns.PatternRuleHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

Direct Known Subclasses:

BitextPatternRuleHandler

public class PatternRuleHandler
extends XMLRuleHandler

Nested Class Summary

Nested classes/interfaces inherited from class org.languagetool.rules.patterns.XMLRuleHandler

XMLRuleHandler.RegexpMode

Field Summary

Fields

Modifier and Type	Field	Description
private int	antiPatternCounter
protected Category	category
protected String	categoryIssueType
private boolean	defaultOff
private boolean	defaultTempOff
private int	distanceTokens
private int	endPos
private static final String	EXTERNAL
protected String	filterArgs
protected String	filterClassName
private String	idPrefix
private boolean	inAntiPattern
private boolean	inRule
private final Map<String,URL>	internedUrls
private boolean	interpretPosTagsPreDisambiguation
private boolean	isRuleSuppressMisspelled
private boolean	isSuggestionSuppressMisspelled
(package private) static final String	MARKER_TAG
private int	minPrevMatches
protected String	name
(package private) static final String	PLEASE_SPELL_ME
(package private) static final String	RAW_TAG
private boolean	relaxedMode
private final List<DisambiguationPatternRule>	ruleAntiPatterns
private final List<DisambiguationPatternRule>	rulegroupAntiPatterns
private boolean	ruleGroupDefaultOff
private boolean	ruleGroupDefaultTempOff
private String	ruleGroupDescription
private int	ruleGroupDistanceTokens
protected String	ruleGroupIssueType
private int	ruleGroupMinPrevMatches
protected String	ruleIssueType
protected final String	sourceFile
private int	startPos
private int	subId
private int	tokenCountForMarker
static final String	TYPE

Fields inherited from class org.languagetool.rules.patterns.XMLRuleHandler

AND, andGroupCounter, ANTIPATTERN, antiPatternExample, antipatternExamples, antiPatternForRuleGroupExample, antipatternForRuleGroupsExamples, CASE_SENSITIVE, caseSensitive, categoryTags, categoryToneTags, chunkTag, CHUNKTAG, CHUNKTAG_REGEXP, correctExample, correctExamples, DEFAULT, DISTANCETOKENS, elements, endPositionCorrection, equivalenceFeatures, errorTriggerExample, errorTriggeringExamples, EXAMPLE, exampleCorrection, EXCEPTION, exceptionLevelCaseSensitive, exceptionLevelCaseSet, exceptionPosNegation, exceptionPosRegExp, exceptionPosToken, exceptions, exceptionSet, exceptionSpaceBefore, exceptionSpaceBeforeSet, exceptionStringInflected, exceptionStringNegation, exceptionStringRegExp, exceptionValidNext, exceptionValidPrev, FALSE, FEATURE, GOAL_SPECIFIC, id, ID, IGNORE, inAndGroup, inAntiPatternExample, inAntiPatternForRuleGroupExample, incorrectExample, inCorrectExample, incorrectExamples, inErrorTriggerExample, inException, INFLECTED, inIncorrectExample, inMarker, inMatch, inMessage, inOrGroup, inPattern, inPhrases, inRegex, inRuleGroup, inShortMessage, inShortMessageForRuleGroup, inSuggestion, inToken, inUnification, inUnificationDef, inUnificationNeutral, inUrl, inUrlForRuleGroup, isGoalSpecific, isGoalSpecificCategoryAttribute, isGoalSpecificRuleGroupAttribute, isPremiumRule, language, lastPhrase, MARK, MARKER, match, MATCH, MAX, maxOccurrence, message, MESSAGE, messages, MIN, minOccurrence, MINPREVMATCHES, NAME, NEGATE, NEGATE_POS, NO, OFF, ON, OR, orGroupCounter, PATTERN, patternToken, patternTokens, phraseId, phraseIdRef, phraseMap, phrasePatternTokens, PHRASES, pLocator, posNegation, posRegExp, POSTAG, POSTAG_REGEXP, posToken, PREMIUM, premiumCategoryAttribute, premiumFileAttribute, premiumRuleGroupAttribute, PRIO, prioCategoryAttribute, prioRuleAttribute, prioRuleGroupAttribute, regex, regexCaseSensitive, regexMode, REGEXP, regexpMark, regExpression, RULE, RULEGROUP, ruleGroupId, ruleGroupTags, ruleGroupToneTags, rules, RULES, ruleTags, ruleToneTags, SCOPE, shortMessage, shortMessageForRuleGroup, SKIP, skipPos, SPACEBEFORE, startPositionCorrection, SUGGESTION, suggestionMatches, suggestionMatchesOutMsg, suggestionsOutMsg, TABNAME, TEMP_OFF, TOKEN, tokenCounter, tokenInflected, tokenLevelCaseSensitive, tokenLevelCaseSet, tokenNegated, tokenReference, tokenSpaceBefore, tokenSpaceBeforeSet, TRUE, uFeature, UNIFICATION, UNIFY, UNIFY_IGNORE, uniNegation, url, urlForRuleGroup, uType, uTypeList, xmlLineNumber, xmlLineNumberAntiPattern, YES

Constructor Summary

Constructors

Constructor	Description
PatternRuleHandler()
PatternRuleHandler(String sourceFile)
PatternRuleHandler(String filename, Language lang)

Method Summary

Modifier and Type	Method	Description
void	characters(char[] buf, int offset, int len)
private void	createRules(List<PatternToken> elemList, List<PatternToken> tmpPatternTokens, int numElement)	Create rule from an Element list.
void	endElement(String namespaceURI, String sName, String qName)
private URL	internUrl(String s)
protected void	prepareRule(AbstractPatternRule rule)
(package private) String	replaceSpacesInRegex(String s)
InputSource	resolveEntity(String publicId, String systemId)
(package private) void	setRelaxedMode(boolean relaxedMode)	If set to true, don't throw an exception if id or name is not set.
void	startElement(String namespaceURI, String lName, String qName, Attributes attrs)

Methods inherited from class org.languagetool.rules.patterns.XMLRuleHandler

addLegacyMatches, error, finalizeExceptions, finalizePhrase, finalizeTokens, getRules, preparePhrase, processElement, resetException, resetToken, setDocumentLocator, setExceptions, setMatchElement, setRuleFilter, setToken, startPattern, warning

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endDocument, endPrefixMapping, fatalError, ignorableWhitespace, notationDecl, processingInstruction, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

declaration

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

MARKER_TAG

static final String MARKER_TAG

See Also:

• Constant Field Values

RAW_TAG

static final String RAW_TAG

See Also:

• Constant Field Values

PLEASE_SPELL_ME

static final String PLEASE_SPELL_ME

See Also:

• Constant Field Values

EXTERNAL

private static final String EXTERNAL

See Also:

• Constant Field Values

sourceFile

protected final String sourceFile

category

protected Category category

categoryIssueType

protected String categoryIssueType

ruleGroupIssueType

protected String ruleGroupIssueType

ruleIssueType

protected String ruleIssueType

name

protected String name

filterClassName

protected String filterClassName

filterArgs

protected String filterArgs

rulegroupAntiPatterns

private final List<DisambiguationPatternRule> rulegroupAntiPatterns

ruleAntiPatterns

private final List<DisambiguationPatternRule> ruleAntiPatterns

subId

private int subId

interpretPosTagsPreDisambiguation

private boolean interpretPosTagsPreDisambiguation

defaultOff

private boolean defaultOff

defaultTempOff

private boolean defaultTempOff

ruleGroupDefaultOff

private boolean ruleGroupDefaultOff

ruleGroupDefaultTempOff

private boolean ruleGroupDefaultTempOff

ruleGroupDescription

private String ruleGroupDescription

startPos

private int startPos

endPos

private int endPos

tokenCountForMarker

private int tokenCountForMarker

antiPatternCounter

private int antiPatternCounter

inRule

private boolean inRule

relaxedMode

private boolean relaxedMode

inAntiPattern

private boolean inAntiPattern

isRuleSuppressMisspelled

private boolean isRuleSuppressMisspelled

isSuggestionSuppressMisspelled

private boolean isSuggestionSuppressMisspelled

minPrevMatches

private int minPrevMatches

ruleGroupMinPrevMatches

private int ruleGroupMinPrevMatches

distanceTokens

private int distanceTokens

ruleGroupDistanceTokens

private int ruleGroupDistanceTokens

idPrefix

private String idPrefix

internedUrls

private final Map<String,URL> internedUrls

Constructor Details

PatternRuleHandler

public PatternRuleHandler()

PatternRuleHandler

public PatternRuleHandler(String sourceFile)

PatternRuleHandler

public PatternRuleHandler(String filename,
 Language lang)

Method Details

resolveEntity

public InputSource resolveEntity(String publicId,
 String systemId)
                          throws IOException,
SAXException

Specified by:

resolveEntity in interface EntityResolver

Overrides:

resolveEntity in class DefaultHandler

Throws:

IOException

SAXException

setRelaxedMode

void setRelaxedMode(boolean relaxedMode)

If set to true, don't throw an exception if id or name is not set. Used for online rule editor.

Since:

2.1

startElement

public void startElement(String namespaceURI,
 String lName,
 String qName,
 Attributes attrs)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

endElement

public void endElement(String namespaceURI,
 String sName,
 String qName)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

createRules

private void createRules(List<PatternToken> elemList,
 List<PatternToken> tmpPatternTokens,
 int numElement)

Create rule from an Element list. In case of OR groups, several rules are created recursively.

Parameters:

elemList - The complete original Element list

tmpPatternTokens - Temporary list being created

numElement - Index of elemList being analyzed

Since:

2.3

replaceSpacesInRegex

String replaceSpacesInRegex(String s)

prepareRule

protected void prepareRule(AbstractPatternRule rule)

internUrl

private URL internUrl(String s)
               throws MalformedURLException

Throws:

MalformedURLException

characters

public void characters(char[] buf,
 int offset,
 int len)

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler