Package org.languagetool.tools

Class RuleMatchAsXmlSerializer

java.lang.Object

org.languagetool.tools.RuleMatchAsXmlSerializer

public class RuleMatchAsXmlSerializer
extends java.lang.Object

Deprecated.

don't use for new use cases, the only place this should still be used is for the API mode of the command-line client (deprecated since 3.5)

Generate XML to represent matching rules.

Since:

2.5 (as 'RuleAsXmlSerializer' up to 3.1)

Field Summary

Fields

Modifier and Type	Field	Description
private static int	CAPACITY	Deprecated.

Constructor Summary

Constructors

Constructor	Description
RuleMatchAsXmlSerializer()	Deprecated.

Method Summary

Modifier and Type	Method	Description
private static java.lang.String	escapeXMLForAPIOutput(java.lang.String s)	Deprecated.
java.lang.String	getXmlEnd()	Deprecated. Get the string to end the XML.
java.lang.String	getXmlStart(Language lang, Language motherTongue)	Deprecated. Get the string to begin the XML.
private java.lang.String	getXmlUnknownWords(java.util.List<java.lang.String> unknownWords)	Deprecated.
java.lang.String	ruleMatchesToXml(java.util.List<RuleMatch> ruleMatches, java.lang.String text, int contextSize, Language lang)	Deprecated. Get an XML representation of the given rule matches.
java.lang.String	ruleMatchesToXml(java.util.List<RuleMatch> ruleMatches, java.lang.String text, int contextSize, Language lang, Language motherTongue)	Deprecated. Get an XML representation of the given rule matches.
java.lang.String	ruleMatchesToXml(java.util.List<RuleMatch> ruleMatches, java.lang.String text, int contextSize, StringTools.ApiPrintMode xmlMode, Language lang, java.util.List<java.lang.String> unknownWords)	Deprecated. Get an XML representation of the given rule matches.
java.lang.String	ruleMatchesToXmlSnippet(java.util.List<RuleMatch> ruleMatches, java.lang.String text, int contextSize)	Deprecated. Get the XML snippet (i.e.

Methods inherited from class java.lang.Object

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

Field Detail

CAPACITY

private static final int CAPACITY

Deprecated.

See Also:

Constant Field Values

Constructor Detail

RuleMatchAsXmlSerializer

public RuleMatchAsXmlSerializer()

Deprecated.

Method Detail

getXmlStart

public java.lang.String getXmlStart(Language lang,
                                    Language motherTongue)

Deprecated.

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 java.lang.String getXmlEnd()

Deprecated.

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 java.lang.String ruleMatchesToXmlSnippet(java.util.List<RuleMatch> ruleMatches,
                                                java.lang.String text,
                                                int contextSize)

Deprecated.

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 java.lang.String ruleMatchesToXml(java.util.List<RuleMatch> ruleMatches,
                                         java.lang.String text,
                                         int contextSize,
                                         Language lang,
                                         Language motherTongue)

Deprecated.

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 java.lang.String ruleMatchesToXml(java.util.List<RuleMatch> ruleMatches,
                                         java.lang.String text,
                                         int contextSize,
                                         Language lang)

Deprecated.

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 java.lang.String ruleMatchesToXml(java.util.List<RuleMatch> ruleMatches,
                                         java.lang.String text,
                                         int contextSize,
                                         StringTools.ApiPrintMode xmlMode,
                                         Language lang,
                                         java.util.List<java.lang.String> unknownWords)

Deprecated.

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

getXmlUnknownWords

private java.lang.String getXmlUnknownWords(java.util.List<java.lang.String> unknownWords)

Deprecated.

escapeXMLForAPIOutput

private static java.lang.String escapeXMLForAPIOutput(java.lang.String s)

Deprecated.