net.sf.okapi.filters.properties

Class Parameters

java.lang.Object

net.sf.okapi.common.BaseParameters

net.sf.okapi.common.StringParameters

net.sf.okapi.filters.properties.Parameters

All Implemented Interfaces:

IParameters, ISimplifierRulesParameters

public class Parameters
extends StringParameters
implements ISimplifierRulesParameters

Field Summary

Fields

Modifier and Type	Field and Description
InlineCodeFinder	codeFinder
LocalizationDirectives	locDir

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 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.
InlineCodeFinder	getCodeFinder()
String	getKeyCondition()
LocalizationDirectives	getLocDir()
String	getSimplifierRules() Get the code simplifier rules as defined by SimplifierRules (JavaCC file: core/simplifierrules/SimplifierRules.jj).
String	getSubfilter()
boolean	isCommentsAreNotes()
boolean	isConvertLFandTab()
boolean	isEscapeExtendedChars()
boolean	isExtraComments()
boolean	isExtractOnlyMatchingKey()
boolean	isIdLikeResname()
boolean	isUseCodeFinder()
boolean	isUseKeyCondition()
void	reset() Reset this parameters object to its default values.
void	setCodeFinder(InlineCodeFinder codeFinder)
void	setCommentsAreNotes(boolean commentsAreNotes)
void	setConvertLFandTab(boolean convertLFandTab)
void	setEscapeExtendedChars(boolean escapeExtendedChars)
void	setExtraComments(boolean extraComments)
void	setExtractOnlyMatchingKey(boolean extractOnlyMatchingKey)
void	setIdLikeResname(boolean idLikeResname)
void	setKeyCondition(String keyCondition)
void	setLocDir(LocalizationDirectives locDir)
void	setSimplifierRules(String rules) Set the simplifier rules.
void	setSubfilter(String subfilter)
void	setUseCodeFinder(boolean useCodeFinder)
void	setUseKeyCondition(boolean useKeyCondition)
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

Field Detail

codeFinder

public InlineCodeFinder codeFinder

locDir

public LocalizationDirectives locDir

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

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.

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.

isUseCodeFinder

public boolean isUseCodeFinder()

setUseCodeFinder

public void setUseCodeFinder(boolean useCodeFinder)

getCodeFinder

public InlineCodeFinder getCodeFinder()

setCodeFinder

public void setCodeFinder(InlineCodeFinder codeFinder)

isEscapeExtendedChars

public boolean isEscapeExtendedChars()

setEscapeExtendedChars

public void setEscapeExtendedChars(boolean escapeExtendedChars)

isUseKeyCondition

public boolean isUseKeyCondition()

setUseKeyCondition

public void setUseKeyCondition(boolean useKeyCondition)

isExtractOnlyMatchingKey

public boolean isExtractOnlyMatchingKey()

setExtractOnlyMatchingKey

public void setExtractOnlyMatchingKey(boolean extractOnlyMatchingKey)

getKeyCondition

public String getKeyCondition()

setKeyCondition

public void setKeyCondition(String keyCondition)

isExtraComments

public boolean isExtraComments()

setExtraComments

public void setExtraComments(boolean extraComments)

isCommentsAreNotes

public boolean isCommentsAreNotes()

setCommentsAreNotes

public void setCommentsAreNotes(boolean commentsAreNotes)

getLocDir

public LocalizationDirectives getLocDir()

setLocDir

public void setLocDir(LocalizationDirectives locDir)

isConvertLFandTab

public boolean isConvertLFandTab()

setConvertLFandTab

public void setConvertLFandTab(boolean convertLFandTab)

isIdLikeResname

public boolean isIdLikeResname()

setIdLikeResname

public void setIdLikeResname(boolean idLikeResname)

getSubfilter

public String getSubfilter()

setSubfilter

public void setSubfilter(String subfilter)

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