Package net.sf.okapi.filters.yaml

Class Parameters

java.lang.Object

net.sf.okapi.common.BaseParameters

net.sf.okapi.common.StringParameters

net.sf.okapi.filters.yaml.Parameters

All Implemented Interfaces:

Cloneable, IParameters, ISimplifierRulesParameters

public class Parameters
extends StringParameters
implements ISimplifierRulesParameters

Field Summary

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

buffer

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

path

Fields inherited from interface net.sf.okapi.common.ISimplifierRulesParameters

SIMPLIFIERRULES, SIMPLIFIERRULES_DISPLAY_NAME, SIMPLIFIERRULES_SHORT_DESC

Constructor Summary

Constructors

Constructor	Description
Parameters()

Method Summary

Modifier and Type	Method	Description
void	fromString(String data)	Reset this parameters object to its default values and then load additional parameters from the provided data.
InlineCodeFinder	getCodeFinder()
String	getCodeFinderData()
boolean	getEscapeNonAscii()
String	getExceptions()
boolean	getExtractAllPairs()
boolean	getExtractStandalone()
String	getSimplifierRules()	Get the code simplifier rules as defined by SimplifierRules (JavaCC file: core/simplifierrules/SimplifierRules.jj).
String	getSubfilter()
boolean	getUseCodeFinder()
boolean	getUseFullKeyPath()
boolean	getUseKeyAsName()
boolean	isSubFilterProcessLiteralAsBlock()
boolean	isWrap()
void	reset()	Reset this parameters object to its default values.
void	setCodeFinderData(String data)
void	setEscapeNonAscii(boolean escapeNonAscii)
void	setExceptions(String exceptions)
void	setExtractAllPairs(boolean extractAllPairs)
void	setExtractStandalone(boolean extractStandalone)
void	setSimplifierRules(String rules)	Set the simplifier rules.
void	setSubfilter(String subfilter)
void	setSubFilterProcessLiteralAsBlock(boolean subFilterProcessLiteralAsBlock)
void	setUseCodeFinder(boolean useCodeFinder)
void	setUseFullKeyPath(boolean useFullKeyPath)
void	setUseKeyAsName(boolean useKeyAsName)
void	setWrap(boolean wrap)
String	toString()	Serialize this parameters object to a string.
void	validateSimplifierRules()	Validate the current code simplifier rules.

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

fromString, 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

Methods inherited from interface net.sf.okapi.common.IParameters

copy

Constructor Detail

Parameters

public Parameters()

Method Detail

getExtractStandalone

public boolean getExtractStandalone()

setExtractStandalone

public void setExtractStandalone(boolean extractStandalone)

getExtractAllPairs

public boolean getExtractAllPairs()

setExtractAllPairs

public void setExtractAllPairs(boolean extractAllPairs)

getExceptions

public String getExceptions()

setExceptions

public void setExceptions(String exceptions)

getUseKeyAsName

public boolean getUseKeyAsName()

setUseKeyAsName

public void setUseKeyAsName(boolean useKeyAsName)

getUseFullKeyPath

public boolean getUseFullKeyPath()

setUseFullKeyPath

public void setUseFullKeyPath(boolean useFullKeyPath)

getUseCodeFinder

public boolean getUseCodeFinder()

setUseCodeFinder

public void setUseCodeFinder(boolean useCodeFinder)

getCodeFinder

public InlineCodeFinder getCodeFinder()

getSubfilter

public String getSubfilter()

setSubfilter

public void setSubfilter(String subfilter)

isSubFilterProcessLiteralAsBlock

public boolean isSubFilterProcessLiteralAsBlock()

setSubFilterProcessLiteralAsBlock

public void setSubFilterProcessLiteralAsBlock(boolean subFilterProcessLiteralAsBlock)

getCodeFinderData

public String getCodeFinderData()

setCodeFinderData

public void setCodeFinderData(String data)

getEscapeNonAscii

public boolean getEscapeNonAscii()

setEscapeNonAscii

public void setEscapeNonAscii(boolean escapeNonAscii)

isWrap

public boolean isWrap()

setWrap

public void setWrap(boolean wrap)

getSimplifierRules

public String getSimplifierRules()

Description copied from interface: ISimplifierRulesParameters

Get the code simplifier rules as defined by SimplifierRules (JavaCC file: core/simplifierrules/SimplifierRules.jj).

Specified by:

getSimplifierRules in interface ISimplifierRulesParameters

Returns:

rules as a string.

setSimplifierRules

public void setSimplifierRules(String rules)

Description copied from interface: ISimplifierRulesParameters

Set the simplifier rules.

Specified by:

setSimplifierRules in interface ISimplifierRulesParameters

Parameters:

rules - new simplifier rules

validateSimplifierRules

public void validateSimplifierRules()
                             throws ParseException

Description copied from interface: ISimplifierRulesParameters

Validate the current code simplifier rules.

Specified by:

validateSimplifierRules in interface ISimplifierRulesParameters

Throws:

ParseException - if the rule cannot be parsed

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.

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.