Package net.sf.okapi.filters.icml

Class Parameters

java.lang.Object

net.sf.okapi.common.BaseParameters

net.sf.okapi.common.StringParameters

net.sf.okapi.filters.icml.Parameters

All Implemented Interfaces:

IParameters, ISimplifierRulesParameters, IEditorDescriptionProvider

public class Parameters
extends StringParameters
implements IEditorDescriptionProvider, 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
EditorDescription	createEditorDescription(ParametersDescription paramsDesc)
void	fromString(String data)	Reset this parameters object to its default values and then load additional parameters from the provided data.
boolean	getExtractMasterSpreads()
boolean	getExtractNotes()
boolean	getNewTuOnBr()
ParametersDescription	getParametersDescription()	Gets the description of the parameters.
String	getSimplifierRules()	Get the code simplifier rules as defined by SimplifierRules (JavaCC file: core/simplifierrules/SimplifierRules.jj).
boolean	getSimplifyCodes()
int	getSkipThreshold()
void	reset()	Reset this parameters object to its default values.
void	setExtractMasterSpreads(boolean extractMasterSpreads)
void	setExtractNotes(boolean extractNotes)
void	setNewTuOnBr(boolean newTuOnBr)
void	setSimplifierRules(String rules)	Set the simplifier rules.
void	setSimplifyCodes(boolean simplifyCodes)
void	setSkipThreshold(int skipThreshold)
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

getPath, load, load, save, setPath

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameters

public Parameters()

Method Detail

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.

getExtractNotes

public boolean getExtractNotes()

setExtractNotes

public void setExtractNotes(boolean extractNotes)

getSimplifyCodes

public boolean getSimplifyCodes()

setSimplifyCodes

public void setSimplifyCodes(boolean simplifyCodes)

getExtractMasterSpreads

public boolean getExtractMasterSpreads()

setExtractMasterSpreads

public void setExtractMasterSpreads(boolean extractMasterSpreads)

getSkipThreshold

public int getSkipThreshold()

setSkipThreshold

public void setSkipThreshold(int skipThreshold)

getNewTuOnBr

public boolean getNewTuOnBr()

setNewTuOnBr

public void setNewTuOnBr(boolean newTuOnBr)

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

getParametersDescription

public ParametersDescription getParametersDescription()

Description copied from interface: IParameters

Gets the description of the parameters.

Specified by:

getParametersDescription in interface IParameters

Overrides:

getParametersDescription in class BaseParameters

Returns:

the ParametersDescription object for this set of parameters, or null if none is provided.

createEditorDescription

public EditorDescription createEditorDescription(ParametersDescription paramsDesc)

Specified by:

createEditorDescription in interface IEditorDescriptionProvider