org.languagetool.tools

Class RuleAsXmlSerializer

java.lang.Object

org.languagetool.tools.RuleAsXmlSerializer

public class RuleAsXmlSerializer
extends Object

Generate XML to represent matching rules.

Since:

2.5

Constructor Summary

Constructors

Constructor and Description
RuleAsXmlSerializer()

Method Summary

Methods

Modifier and Type	Method and Description
String	getXmlEnd() Get the string to end the XML.
String	getXmlStart(Language lang, Language motherTongue) Get the string to begin the XML.
String	ruleMatchesToXml(List<RuleMatch> ruleMatches, String text, int contextSize, Language lang) Get an XML representation of the given rule matches.
String	ruleMatchesToXml(List<RuleMatch> ruleMatches, String text, int contextSize, Language lang, Language motherTongue) Get an XML representation of the given rule matches.
String	ruleMatchesToXml(List<RuleMatch> ruleMatches, String text, int contextSize, StringTools.XmlPrintMode xmlMode, Language lang, List<String> unknownWords) Get an XML representation of the given rule matches.
String	ruleMatchesToXmlSnippet(List<RuleMatch> ruleMatches, String text, int contextSize) Get the XML snippet (i.e. not a complete XML document) for the given rules.

Methods inherited from class java.lang.Object

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

Constructor Detail

RuleAsXmlSerializer

public RuleAsXmlSerializer()

Method Detail

getXmlStart

public String getXmlStart(Language lang,
                 Language motherTongue)

Get the string to begin the XML. After this, use ruleMatchesToXmlSnippet(java.util.List<org.languagetool.rules.RuleMatch>, java.lang.String, int) and then getXmlEnd() or better, simply use ruleMatchesToXml(java.util.List<org.languagetool.rules.RuleMatch>, java.lang.String, int, org.languagetool.Language, org.languagetool.Language).

getXmlEnd

public String getXmlEnd()

Get the string to end the XML. Use after ruleMatchesToXmlSnippet(java.util.List<org.languagetool.rules.RuleMatch>, java.lang.String, int) and getXmlStart(org.languagetool.Language, org.languagetool.Language).

ruleMatchesToXmlSnippet

public String ruleMatchesToXmlSnippet(List<RuleMatch> ruleMatches,
                             String text,
                             int contextSize)

Get the XML snippet (i.e. not a complete XML document) for the given rules.

See Also:

getXmlStart(org.languagetool.Language, org.languagetool.Language), getXmlEnd()

ruleMatchesToXml

public String ruleMatchesToXml(List<RuleMatch> ruleMatches,
                      String text,
                      int contextSize,
                      Language lang,
                      Language motherTongue)

Get an XML representation of the given rule matches.

Parameters:

text - the original text that was checked, used to get the context of the matches

contextSize - the desired context size in characters

ruleMatchesToXml

public String ruleMatchesToXml(List<RuleMatch> ruleMatches,
                      String text,
                      int contextSize,
                      Language lang)

Get an XML representation of the given rule matches.

Parameters:

text - the original text that was checked, used to get the context of the matches

contextSize - the desired context size in characters

ruleMatchesToXml

public String ruleMatchesToXml(List<RuleMatch> ruleMatches,
                      String text,
                      int contextSize,
                      StringTools.XmlPrintMode xmlMode,
                      Language lang,
                      List<String> unknownWords)

Get an XML representation of the given rule matches.

Parameters:

text - the original text that was checked, used to get the context of the matches

contextSize - the desired context size in characters

unknownWords - unknown words to be printed in a separated list

Since:

3.0