net.sf.okapi.lib.verification

Class AbstractChecker

java.lang.Object

net.sf.okapi.lib.verification.AbstractChecker

Direct Known Subclasses:

CharactersChecker, GeneralChecker, InlineCodesChecker, LengthChecker, LocalizableChecker, PatternsChecker

public abstract class AbstractChecker
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected GenericContent	genCont
static Pattern	WORDCHARS
static Pattern	WORDCHARS_NONUMBERS

Constructor Summary

Constructors

Constructor and Description
AbstractChecker()

Method Summary

Modifier and Type	Method and Description
void	addAnnotation(TextContainer tc, String segId, IssueType issueType, String comment, int srcStart, int srcEnd, int trgStart, int trgEnd, double severity, List<Code> codes)
void	addAnnotation(TextContainer tc, String segId, IssueType issueType, String comment, int srcStart, int srcEnd, int trgStart, int trgEnd, double severity, List<Code> codes, String itsType)
void	addAnnotationAndReportIssue(IssueType issueType, ITextUnit tu, TextContainer tc, String segId, String comment, int srcStart, int srcEnd, int trgStart, int trgEnd, double severity, String srcOri, String trgOri, List<Code> codes)
void	addAnnotationAndReportIssue(IssueType issueType, ITextUnit tu, TextContainer tc, String segId, String comment, int srcStart, int srcEnd, int trgStart, int trgEnd, double severity, String srcOri, String trgOri, List<Code> codes, String itsType)
static int	fromFragmentToGeneric(TextFragment frag, int pos) Converts a position in a coded-text string into the same position when the string display uses generic codes.
static int	fromOriginalToGeneric(TextFragment frag, int pos) Converts a position in a string display using the original code data into the same position when the string display uses generic codes.
static int	fromStrippedToGeneric(TextFragment frag, int pos) Converts a position in a string display where codes are stripped into the same position when the string display uses generic codes.
static int	fromStrippedToString(TextFragment frag, int pos) Converts a position in a string display where codes are stripped into the same position when the string display uses original data.
URI	getCurrentDocId()
String	getCurrentSubDocId()
protected String	getDisplay(TextContainer tc) Generates the display string for a source or target text=container.
protected String	getDisplay(TextFragment frag) Generates the display string for a source or target text-fragment (e.g.
List<Issue>	getIssues()
Parameters	getParams()
List<String>	getSigList()
LocaleId	getSrcLoc()
LocaleId	getTrgLoc()
boolean	isMonolingual()
void	processStartDocument(StartDocument sd, List<String> sigList)
void	processStartSubDocument(StartSubDocument ssd)
abstract void	processTextUnit(ITextUnit tu)
void	reportIssue(Issue init, ITextUnit tu, String srcOri, String trgOri, Object extra) Deprecated.
void	reportIssue(IssueType issueType, ITextUnit tu, String segId, String message, int srcStart, int srcEnd, int trgStart, int trgEnd, double severity, String srcOri, String trgOri, List<Code> codes)
void	setAnnotationIds(TextContainer srcCont, TextContainer trgCont)
void	startProcess(LocaleId sourceLocale, LocaleId targetLocale, Parameters params, List<Issue> issues)

Methods inherited from class java.lang.Object

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

Field Detail

WORDCHARS

public static final Pattern WORDCHARS

WORDCHARS_NONUMBERS

public static final Pattern WORDCHARS_NONUMBERS

genCont

protected final GenericContent genCont

Constructor Detail

AbstractChecker

public AbstractChecker()

Method Detail

fromFragmentToGeneric

public static int fromFragmentToGeneric(TextFragment frag,
                                        int pos)

Converts a position in a coded-text string into the same position when the string display uses generic codes.

Parameters:

frag - the text-fragment displayed.

pos - the position in the coded-text string

Returns:

the position when the codes' generic representations are used

fromOriginalToGeneric

public static int fromOriginalToGeneric(TextFragment frag,
                                        int pos)

Converts a position in a string display using the original code data into the same position when the string display uses generic codes.

Parameters:

frag - the text-fragment displayed.

pos - the position when the codes' original data are used

Returns:

the position when the codes' generic representations are used

fromStrippedToGeneric

public static int fromStrippedToGeneric(TextFragment frag,
                                        int pos)

Converts a position in a string display where codes are stripped into the same position when the string display uses generic codes.

Parameters:

frag - the text-fragment displayed.

pos - the position when the codes are stripped.

Returns:

the position when the codes' generic representations are used

fromStrippedToString

public static int fromStrippedToString(TextFragment frag,
                                       int pos)

Converts a position in a string display where codes are stripped into the same position when the string display uses original data.

Parameters:

frag - the text-fragment displayed.

pos - the position when the codes are stripped

Returns:

the position when the codes' original data are used.

startProcess

public void startProcess(LocaleId sourceLocale,
                         LocaleId targetLocale,
                         Parameters params,
                         List<Issue> issues)

processStartDocument

public void processStartDocument(StartDocument sd,
                                 List<String> sigList)

processStartSubDocument

public void processStartSubDocument(StartSubDocument ssd)

processTextUnit

public abstract void processTextUnit(ITextUnit tu)

addAnnotationAndReportIssue

public void addAnnotationAndReportIssue(IssueType issueType,
                                        ITextUnit tu,
                                        TextContainer tc,
                                        String segId,
                                        String comment,
                                        int srcStart,
                                        int srcEnd,
                                        int trgStart,
                                        int trgEnd,
                                        double severity,
                                        String srcOri,
                                        String trgOri,
                                        List<Code> codes)

addAnnotationAndReportIssue

public void addAnnotationAndReportIssue(IssueType issueType,
                                        ITextUnit tu,
                                        TextContainer tc,
                                        String segId,
                                        String comment,
                                        int srcStart,
                                        int srcEnd,
                                        int trgStart,
                                        int trgEnd,
                                        double severity,
                                        String srcOri,
                                        String trgOri,
                                        List<Code> codes,
                                        String itsType)

addAnnotation

public void addAnnotation(TextContainer tc,
                          String segId,
                          IssueType issueType,
                          String comment,
                          int srcStart,
                          int srcEnd,
                          int trgStart,
                          int trgEnd,
                          double severity,
                          List<Code> codes)

addAnnotation

public void addAnnotation(TextContainer tc,
                          String segId,
                          IssueType issueType,
                          String comment,
                          int srcStart,
                          int srcEnd,
                          int trgStart,
                          int trgEnd,
                          double severity,
                          List<Code> codes,
                          String itsType)

reportIssue

public void reportIssue(IssueType issueType,
                        ITextUnit tu,
                        String segId,
                        String message,
                        int srcStart,
                        int srcEnd,
                        int trgStart,
                        int trgEnd,
                        double severity,
                        String srcOri,
                        String trgOri,
                        List<Code> codes)

reportIssue

@Deprecated
public void reportIssue(Issue init,
                                    ITextUnit tu,
                                    String srcOri,
                                    String trgOri,
                                    Object extra)

Deprecated.

This method does not seem to be used anywhere and its last parameter is not used. We may remove this method at some point in the future. Use the other reportIssue(IssueType, ITextUnit, String, String, int, int, int, int, double, String, String, List) method instead.

setAnnotationIds

public void setAnnotationIds(TextContainer srcCont,
                             TextContainer trgCont)

getSrcLoc

public LocaleId getSrcLoc()

getTrgLoc

public LocaleId getTrgLoc()

getCurrentDocId

public URI getCurrentDocId()

getCurrentSubDocId

public String getCurrentSubDocId()

getParams

public Parameters getParams()

getIssues

public List<Issue> getIssues()

getSigList

public List<String> getSigList()

isMonolingual

public boolean isMonolingual()

getDisplay

protected String getDisplay(TextFragment frag)

Generates the display string for a source or target text-fragment (e.g. a segment).

Parameters:

frag - the fragment to display.

Returns:

the string representation based on the options (e.g. tags: original data or generic)

getDisplay

protected String getDisplay(TextContainer tc)

Generates the display string for a source or target text=container.

Parameters:

tc - the text-container to display.

Returns:

the string representation based on the options (e.g. tags: original data or generic)