Package net.sf.okapi.common

Class AbstractGroupParameters

java.lang.Object

net.sf.okapi.common.BaseParameters

net.sf.okapi.common.StringParameters

net.sf.okapi.common.AbstractGroupParameters

All Implemented Interfaces:

Cloneable, IParameters, ISimplifierRulesParameters

Direct Known Subclasses:

CompoundFilterParameters, Parameters, Parameters, Parameters, TokenConfigs, TokenConfigs.TokenConfig

public abstract class AbstractGroupParameters
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
AbstractGroupParameters()

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.
String	getData()
String	getSimplifierRules()	Get the code simplifier rules as defined by SimplifierRules (JavaCC file: core/simplifierrules/SimplifierRules.jj).
protected abstract void	load(ParametersString buffer)	Load from buffer.
boolean	loadFromResource(Class<?> classRef, String resourceLocation)
<T extends AbstractGroupParameters> void	loadGroup(ParametersString buffer, String groupName, List<T> group, Class<T> elementClass)
<T extends AbstractGroupParameters> void	loadGroup(ParametersString buffer, List<T> group, Class<T> elementClass)
protected abstract void	save(ParametersString buffer)	Save to buffer.
<T extends AbstractGroupParameters> void	saveGroup(ParametersString buffer, String groupName, List<T> group)
<T extends AbstractGroupParameters> void	saveGroup(ParametersString buffer, List<T> group, Class<T> elementClass)
void	saveToResource(Class<?> classRef, String resourceLocation)
void	setSimplifierRules(String rules)	Set the simplifier rules.
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, reset, 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

AbstractGroupParameters

public AbstractGroupParameters()

Method Detail

load

protected abstract void load(ParametersString buffer)

Load from buffer. The protected buffer variable is visible in all subclasses of BaseParameters.

save

protected abstract void save(ParametersString buffer)

Save to buffer. The protected buffer variable is visible in all subclasses of BaseParameters.

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 final 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.

loadGroup

public <T extends AbstractGroupParameters> void loadGroup(ParametersString buffer,
                                                          List<T> group,
                                                          Class<T> elementClass)

loadGroup

public <T extends AbstractGroupParameters> void loadGroup(ParametersString buffer,
                                                          String groupName,
                                                          List<T> group,
                                                          Class<T> elementClass)

saveGroup

public <T extends AbstractGroupParameters> void saveGroup(ParametersString buffer,
                                                          String groupName,
                                                          List<T> group)

saveGroup

public <T extends AbstractGroupParameters> void saveGroup(ParametersString buffer,
                                                          List<T> group,
                                                          Class<T> elementClass)

loadFromResource

public boolean loadFromResource(Class<?> classRef,
                                String resourceLocation)

saveToResource

public void saveToResource(Class<?> classRef,
                           String resourceLocation)

getData

public String getData()

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