net.sf.okapi.lib.verification

Class Parameters

java.lang.Object

net.sf.okapi.common.BaseParameters

net.sf.okapi.common.StringParameters

net.sf.okapi.lib.verification.Parameters

All Implemented Interfaces:

IParameters

public class Parameters
extends StringParameters

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILE_EXTENSION
static int	SCOPE_ALL
static int	SCOPE_APPROVEDONLY
static int	SCOPE_NOTAPPROVEDONLY
static String	XLIFF_SCHEMA_NONE
static String	XLIFF_SCHEMA_STRICT
static String	XLIFF_SCHEMA_TRANSITIONAL

Fields inherited from class net.sf.okapi.common.StringParameters

buffer

Fields inherited from class net.sf.okapi.common.BaseParameters

path

Constructor Summary

Constructors

Constructor and Description
Parameters()

Method Summary

Modifier and Type	Method and Description
void	fromString(String data) Reset this parameters object to its default values and then load additional parameters from the provided data.
void	fromString(String data, boolean clearParameters) Load additional parameters from the provided data.
int	getAbsoluteMaxCharLength()
boolean	getAllowBlacklistSub()
boolean	getAutoOpen()
boolean	getBetweenCodes()
String	getBlacklistPath()
boolean	getBlacklistSrc()
InputStream	getBlacklistStream()
String	getCharset()
boolean	getCheckAbsoluteMaxCharLength()
boolean	getCheckAllowedCharacters()
boolean	getCheckBlacklist()
boolean	getCheckCharacters()
boolean	getCheckMaxCharLength()
boolean	getCheckMinCharLength()
boolean	getCheckPatterns()
boolean	getCheckStorageSize()
boolean	getCheckTerms()
boolean	getCheckWithLT()
boolean	getCheckXliffSchema()
boolean	getCodeDifference()
boolean	getCorruptedCharacters()
boolean	getDoubledWord()
String	getDoubledWordExceptions()
boolean	getEmptySource()
boolean	getEmptyTarget()
String	getExtraCharsAllowed()
List<String>	getExtraCodesAllowed()
boolean	getGuessOpenClose()
boolean	getIncludeTextContainers()
boolean	getLeadingWS()
boolean	getLtBilingualMode()
int	getMaxCharLengthAbove()
int	getMaxCharLengthBelow()
int	getMaxCharLengthBreak()
int	getMinCharLengthAbove()
int	getMinCharLengthBelow()
int	getMinCharLengthBreak()
List<String>	getMissingCodesAllowed()
String	getOutputPath()
int	getOutputType()
List<PatternItem>	getPatterns()
boolean	getSaveSession()
int	getScope()
String	getServerURL()
String	getSessionPath()
boolean	getShowFullPath()
boolean	getShowOnlyPatternDescription()
boolean	getStrictCodeOrder()
boolean	getStringMode()
boolean	getTargetSameAsSource()
boolean	getTargetSameAsSourceForSameLanguage()
boolean	getTargetSameAsSourceWithCodes()
boolean	getTargetSameAsSourceWithNumbers()
String	getTermsPath()
boolean	getTrailingWS()
String	getTypesToIgnore()
boolean	getUseGenericCodes()
String	getXliffSchemaType()
void	reset() Reset this parameters object to its default values.
void	setAbsoluteMaxCharLength(int absoluteMaxCharLength)
void	setAllowBlacklistSub(boolean allowBlacklistSub)
void	setAutoOpen(boolean autoOpen)
void	setBetweenCodes(boolean betweenCodes)
void	setblacklistPath(String blacklistPath)
void	setBlacklistSrc(boolean blacklistSrc)
void	setBlacklistStream(InputStream blacklistStream)
void	setCharset(String charset)
void	setCheckAbsoluteMaxCharLength(boolean checkAbsoluteMaxCharLength)
void	setCheckAllowedCharacters(boolean checkAllowedCharacters)
void	setCheckBlacklist(boolean checkBlacklist)
void	setCheckCharacters(boolean checkCharacters)
void	setCheckMaxCharLength(boolean checkMaxCharLength)
void	setCheckMinCharLength(boolean checkMinCharLength)
void	setCheckPatterns(boolean patterns)
void	setCheckStorageSize(boolean checkStorageSize)
void	setCheckTerms(boolean checkTerms)
void	setCheckWithLT(boolean checkWithLT)
void	setCheckXliffSchema(boolean schema)
void	setCodeDifference(boolean codeDifference)
void	setCorruptedCharacters(boolean corruptedCharacters)
void	setDoubledWord(boolean doubledWord)
void	setDoubledWordExceptions(String doubledWordExceptions)
void	setEmptySource(boolean emptySource)
void	setEmptyTarget(boolean emptyTarget)
void	setExtraCharsAllowed(String extraCharsAllowed)
void	setGuessOpenClose(boolean guessOpenClose)
void	setIncludeTextContainers(boolean includeTextContainers)
void	setLeadingWS(boolean leadingWS)
void	setLtBilingualMode(boolean ltBilingualMode)
void	setMaxCharLengthAbove(int maxCharLengthAbove)
void	setMaxCharLengthBelow(int maxCharLengthBelow)
void	setMaxCharLengthBreak(int maxCharLengthBreak)
void	setMinCharLengthAbove(int minCharLengthAbove)
void	setMinCharLengthBelow(int minCharLengthBelow)
void	setMinCharLengthBreak(int minCharLengthBreak)
void	setOutputPath(String outputPath)
void	setOutputType(int outputType)
void	setPatterns(List<PatternItem> patterns)
void	setSaveSession(boolean saveSession)
void	setScope(int scope)
void	setServerURL(String serverURL)
void	setSessionPath(String sessionPath)
void	setShowFullPath(boolean showFullPath)
void	setShowOnlyPatternDescription(boolean showOnlyPatterndescription)
void	setStrictCodeOrder(boolean strictCodeOrder)
void	setStringMode(boolean stringMode)
void	setTargetSameAsSource(boolean targetSameAsSource)
void	setTargetSameAsSourceForSameLanguage(boolean targetSameAsSourceForSameLanguage)
void	setTargetSameAsSourceWithCodes(boolean targetSameAsSourceWithCodes)
void	setTargetSameAsSourceWithNumbers(boolean targetSameAsSourceWithNumbers)
void	setTermsPath(String termsPath)
void	setTrailingWS(boolean trailingWS)
void	setTypesToIgnore(String typesToIgnore)
void	setUseGenericCodes(boolean useGenericCodes)
void	setXliffSchemaType(String schemaType)
String	toString() Serialize this parameters object to a string.

Methods inherited from class net.sf.okapi.common.StringParameters

getBoolean, getGroup, getInteger, getString, setBoolean, setGroup, setInteger, setString

Methods inherited from class net.sf.okapi.common.BaseParameters

getParametersDescription, getPath, load, load, save, setPath

Methods inherited from class java.lang.Object

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

Field Detail

FILE_EXTENSION

public static final String FILE_EXTENSION

See Also:

Constant Field Values

SCOPE_ALL

public static final int SCOPE_ALL

See Also:

Constant Field Values

SCOPE_APPROVEDONLY

public static final int SCOPE_APPROVEDONLY

See Also:

Constant Field Values

SCOPE_NOTAPPROVEDONLY

public static final int SCOPE_NOTAPPROVEDONLY

See Also:

Constant Field Values

XLIFF_SCHEMA_NONE

public static final String XLIFF_SCHEMA_NONE

See Also:

Constant Field Values

XLIFF_SCHEMA_TRANSITIONAL

public static final String XLIFF_SCHEMA_TRANSITIONAL

See Also:

Constant Field Values

XLIFF_SCHEMA_STRICT

public static final String XLIFF_SCHEMA_STRICT

See Also:

Constant Field Values

Constructor Detail

Parameters

public Parameters()

Method Detail

getExtraCodesAllowed

public List<String> getExtraCodesAllowed()

getMissingCodesAllowed

public List<String> getMissingCodesAllowed()

getTypesToIgnore

public String getTypesToIgnore()

setTypesToIgnore

public void setTypesToIgnore(String typesToIgnore)

getScope

public int getScope()

setScope

public void setScope(int scope)

getCorruptedCharacters

public boolean getCorruptedCharacters()

setCorruptedCharacters

public void setCorruptedCharacters(boolean corruptedCharacters)

getCheckAllowedCharacters

public boolean getCheckAllowedCharacters()

setCheckAllowedCharacters

public void setCheckAllowedCharacters(boolean checkAllowedCharacters)

getCheckCharacters

public boolean getCheckCharacters()

setCheckCharacters

public void setCheckCharacters(boolean checkCharacters)

getCharset

public String getCharset()

setCharset

public void setCharset(String charset)

getExtraCharsAllowed

public String getExtraCharsAllowed()

setExtraCharsAllowed

public void setExtraCharsAllowed(String extraCharsAllowed)

getCheckStorageSize

public boolean getCheckStorageSize()

setCheckStorageSize

public void setCheckStorageSize(boolean checkStorageSize)

getCheckMaxCharLength

public boolean getCheckMaxCharLength()

setCheckMaxCharLength

public void setCheckMaxCharLength(boolean checkMaxCharLength)

getMaxCharLengthBreak

public int getMaxCharLengthBreak()

setMaxCharLengthBreak

public void setMaxCharLengthBreak(int maxCharLengthBreak)

getMaxCharLengthAbove

public int getMaxCharLengthAbove()

setMaxCharLengthAbove

public void setMaxCharLengthAbove(int maxCharLengthAbove)

getMaxCharLengthBelow

public int getMaxCharLengthBelow()

setMaxCharLengthBelow

public void setMaxCharLengthBelow(int maxCharLengthBelow)

getCheckMinCharLength

public boolean getCheckMinCharLength()

setCheckMinCharLength

public void setCheckMinCharLength(boolean checkMinCharLength)

getMinCharLengthBreak

public int getMinCharLengthBreak()

setMinCharLengthBreak

public void setMinCharLengthBreak(int minCharLengthBreak)

getMinCharLengthAbove

public int getMinCharLengthAbove()

setMinCharLengthAbove

public void setMinCharLengthAbove(int minCharLengthAbove)

getMinCharLengthBelow

public int getMinCharLengthBelow()

setMinCharLengthBelow

public void setMinCharLengthBelow(int minCharLengthBelow)

getCheckAbsoluteMaxCharLength

public boolean getCheckAbsoluteMaxCharLength()

setCheckAbsoluteMaxCharLength

public void setCheckAbsoluteMaxCharLength(boolean checkAbsoluteMaxCharLength)

getAbsoluteMaxCharLength

public int getAbsoluteMaxCharLength()

setAbsoluteMaxCharLength

public void setAbsoluteMaxCharLength(int absoluteMaxCharLength)

getDoubledWord

public boolean getDoubledWord()

setDoubledWord

public void setDoubledWord(boolean doubledWord)

getDoubledWordExceptions

public String getDoubledWordExceptions()

setDoubledWordExceptions

public void setDoubledWordExceptions(String doubledWordExceptions)

getSaveSession

public boolean getSaveSession()

setSaveSession

public void setSaveSession(boolean saveSession)

getSessionPath

public String getSessionPath()

setSessionPath

public void setSessionPath(String sessionPath)

getOutputPath

public String getOutputPath()

setOutputPath

public void setOutputPath(String outputPath)

getOutputType

public int getOutputType()

setOutputType

public void setOutputType(int outputType)

getAutoOpen

public boolean getAutoOpen()

setAutoOpen

public void setAutoOpen(boolean autoOpen)

getLeadingWS

public boolean getLeadingWS()

setLeadingWS

public void setLeadingWS(boolean leadingWS)

getTrailingWS

public boolean getTrailingWS()

setTrailingWS

public void setTrailingWS(boolean trailingWS)

getEmptyTarget

public boolean getEmptyTarget()

setEmptyTarget

public void setEmptyTarget(boolean emptyTarget)

getEmptySource

public boolean getEmptySource()

setEmptySource

public void setEmptySource(boolean emptySource)

getTargetSameAsSource

public boolean getTargetSameAsSource()

setTargetSameAsSource

public void setTargetSameAsSource(boolean targetSameAsSource)

getTargetSameAsSourceForSameLanguage

public boolean getTargetSameAsSourceForSameLanguage()

setTargetSameAsSourceForSameLanguage

public void setTargetSameAsSourceForSameLanguage(boolean targetSameAsSourceForSameLanguage)

getTargetSameAsSourceWithCodes

public boolean getTargetSameAsSourceWithCodes()

setTargetSameAsSourceWithCodes

public void setTargetSameAsSourceWithCodes(boolean targetSameAsSourceWithCodes)

getTargetSameAsSourceWithNumbers

public boolean getTargetSameAsSourceWithNumbers()

setTargetSameAsSourceWithNumbers

public void setTargetSameAsSourceWithNumbers(boolean targetSameAsSourceWithNumbers)

getCodeDifference

public boolean getCodeDifference()

setCodeDifference

public void setCodeDifference(boolean codeDifference)

getGuessOpenClose

public boolean getGuessOpenClose()

setGuessOpenClose

public void setGuessOpenClose(boolean guessOpenClose)

getStrictCodeOrder

public boolean getStrictCodeOrder()

setStrictCodeOrder

public void setStrictCodeOrder(boolean strictCodeOrder)

getCheckXliffSchema

public boolean getCheckXliffSchema()

setCheckXliffSchema

public void setCheckXliffSchema(boolean schema)

getXliffSchemaType

public String getXliffSchemaType()

setXliffSchemaType

public void setXliffSchemaType(String schemaType)

getCheckPatterns

public boolean getCheckPatterns()

setCheckPatterns

public void setCheckPatterns(boolean patterns)

getPatterns

public List<PatternItem> getPatterns()

setPatterns

public void setPatterns(List<PatternItem> patterns)

getShowOnlyPatternDescription

public boolean getShowOnlyPatternDescription()

setShowOnlyPatternDescription

public void setShowOnlyPatternDescription(boolean showOnlyPatterndescription)

getCheckWithLT

public boolean getCheckWithLT()

setCheckWithLT

public void setCheckWithLT(boolean checkWithLT)

getServerURL

public String getServerURL()

setServerURL

public void setServerURL(String serverURL)

getLtBilingualMode

public boolean getLtBilingualMode()

setLtBilingualMode

public void setLtBilingualMode(boolean ltBilingualMode)

getCheckTerms

public boolean getCheckTerms()

setCheckTerms

public void setCheckTerms(boolean checkTerms)

getCheckBlacklist

public boolean getCheckBlacklist()

getAllowBlacklistSub

public boolean getAllowBlacklistSub()

getBlacklistSrc

public boolean getBlacklistSrc()

setCheckBlacklist

public void setCheckBlacklist(boolean checkBlacklist)

setAllowBlacklistSub

public void setAllowBlacklistSub(boolean allowBlacklistSub)

setBlacklistSrc

public void setBlacklistSrc(boolean blacklistSrc)

getStringMode

public boolean getStringMode()

setStringMode

public void setStringMode(boolean stringMode)

getBetweenCodes

public boolean getBetweenCodes()

setBetweenCodes

public void setBetweenCodes(boolean betweenCodes)

getShowFullPath

public boolean getShowFullPath()

setShowFullPath

public void setShowFullPath(boolean showFullPath)

getIncludeTextContainers

public boolean getIncludeTextContainers()

setIncludeTextContainers

public void setIncludeTextContainers(boolean includeTextContainers)

getUseGenericCodes

public boolean getUseGenericCodes()

setUseGenericCodes

public void setUseGenericCodes(boolean useGenericCodes)

getTermsPath

public String getTermsPath()

setTermsPath

public void setTermsPath(String termsPath)

getBlacklistPath

public String getBlacklistPath()

setblacklistPath

public void setblacklistPath(String blacklistPath)

getBlacklistStream

public InputStream getBlacklistStream()

setBlacklistStream

public void setBlacklistStream(InputStream blacklistStream)

reset

public void reset()

Description copied from class: StringParameters

Reset this parameters object to its default values.

Subclasses should override this method to set any initial values and instantiate any objects that require allocation. It is recommended that subclasses also call super.reset() in the override to ensure that the buffer is empty.

Specified by:

reset in interface IParameters

Overrides:

reset in class StringParameters

fromString

public void fromString(String data)

Description copied from class: StringParameters

Reset this parameters object to its default values and then load additional parameters from the provided data.

Subclasses should not normally need to override this method unless they are maintaining complex values (eg, InlineCodeFinder) that require extra initialization as part of their parameter state.

Specified by:

fromString in interface IParameters

Overrides:

fromString in class StringParameters

Parameters:

data - the string holding the parameters. It must be formatted as the string generated by toString(). Line-breaks must be normalized to '\n'. It can also be null or empty, in such case the parameters are left with their current values. Use reset() to reset the parameters to their defaults.

fromString

public void fromString(String data,
                       boolean clearParameters)

Description copied from class: StringParameters

Load additional parameters from the provided data. If clearParameters is set, then it first resets this parameters object to its default values.

Subclasses should not normally need to override this method unless they are maintaining complex values (eg, InlineCodeFinder) that require extra initialization as part of their parameter state.

Overrides:

fromString in class StringParameters

Parameters:

data - the string holding the parameters. See IParameters.fromString(java.lang.String).

clearParameters - if true, the internal parameters will be cleared before loading the data. If false, any existing parameters will be left intact unless they are overridden by the data.

toString

public String toString()

Description copied from class: StringParameters

Serialize this parameters object to a string.

Subclasses should not normally need to override this method unless they are maintaining complex values (eg, InlineCodeFinder) that require extra serialization as part of their parameter state.

Specified by:

toString in interface IParameters

Overrides:

toString in class StringParameters

Returns:

the string holding all the parameters.