Package net.sf.okapi.filters.vignette

Class Parameters

java.lang.Object

net.sf.okapi.common.BaseParameters

net.sf.okapi.common.StringParameters

net.sf.okapi.filters.vignette.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
boolean	checkData()
EditorDescription	createEditorDescription(ParametersDescription paramDesc)
String	getLocaleId()
boolean	getMonolingual()
ParametersDescription	getParametersDescription()	Gets the description of the parameters.
String	getPartsConfigurations()
String[]	getPartsConfigurationsAsList()
String	getPartsNames()
String[]	getPartsNamesAsList()
String	getSimplifierRules()	Get the code simplifier rules as defined by SimplifierRules (JavaCC file: core/simplifierrules/SimplifierRules.jj).
String	getSourceId()
boolean	getUseCDATA()
void	reset()	Reset this parameters object to its default values.
void	setLocaleId(String localeId)
void	setMonolingual(boolean monolingual)
void	setPartsConfigurations(String partsConfigurations)
void	setPartsNames(String partsNames)
void	setSimplifierRules(String rules)	Set the simplifier rules.
void	setSourceId(String sourceId)
void	setUseCDATA(boolean useCDATA)
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, 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

getPartsNames

public String getPartsNames()

getPartsNamesAsList

public String[] getPartsNamesAsList()

setPartsNames

public void setPartsNames(String partsNames)

getPartsConfigurations

public String getPartsConfigurations()

getPartsConfigurationsAsList

public String[] getPartsConfigurationsAsList()

setPartsConfigurations

public void setPartsConfigurations(String partsConfigurations)

getSourceId

public String getSourceId()

setSourceId

public void setSourceId(String sourceId)

getLocaleId

public String getLocaleId()

setLocaleId

public void setLocaleId(String localeId)

getMonolingual

public boolean getMonolingual()

setMonolingual

public void setMonolingual(boolean monolingual)

getUseCDATA

public boolean getUseCDATA()

setUseCDATA

public void setUseCDATA(boolean useCDATA)

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

checkData

public boolean checkData()

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.

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 paramDesc)

Specified by:

createEditorDescription in interface IEditorDescriptionProvider