net.sf.okapi.lib.extra

Class AbstractParameters

java.lang.Object

net.sf.okapi.common.BaseParameters

net.sf.okapi.common.StringParameters

net.sf.okapi.lib.extra.AbstractParameters

All Implemented Interfaces:

IParameters, ISimplifierRulesParameters, INotifiable

Direct Known Subclasses:

CompoundFilterParameters, Config, LanguageParameters, LexerRules, Parameters, Parameters, Parameters, Parameters, StructureParameters, StructureParameters, StructureParametersItem, TokenItem

public abstract class AbstractParameters
extends StringParameters
implements INotifiable, ISimplifierRulesParameters

Version:

0.1, 18.06.2009

Field Summary

Fields

Modifier and Type	Field and Description
protected Component	owner

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
AbstractParameters()

Method Summary

Modifier and Type	Method and Description
boolean	exec(Object sender, String command, Object info) Sends a command for the object to react
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).
boolean	loadFromResource(Class<?> classRef, String resourceLocation)
boolean	loadFromResource(String resourceLocation)
<T extends AbstractParameters> void	loadGroup(ParametersString buffer, List<T> group, Class<T> elementClass)
<T extends AbstractParameters> void	loadGroup(ParametersString buffer, String groupName, List<T> group, Class<T> elementClass)
protected void	parameters_init() Called from the parameters' constructor.
protected abstract void	parameters_load(ParametersString buffer) Load from buffer.
protected abstract void	parameters_reset() Reset parameters values to defaults.
protected abstract void	parameters_save(ParametersString buffer) Save to buffer.
void	reset() Reset this parameters object to its default values.
<T extends AbstractParameters> void	saveGroup(ParametersString buffer, List<T> group, Class<T> elementClass)
<T extends AbstractParameters> void	saveGroup(ParametersString buffer, String groupName, List<T> group)
void	saveToResource(Class<?> classRef, String resourceLocation)
void	saveToResource(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, 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

owner

protected Component owner

Constructor Detail

AbstractParameters

public AbstractParameters()

Method Detail

parameters_init

protected void parameters_init()

Called from the parameters' constructor. Create local objects here or leave empty. Initial values are assigned in reset().

parameters_reset

protected abstract void parameters_reset()

Reset parameters values to defaults.

parameters_load

protected abstract void parameters_load(ParametersString buffer)

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

parameters_save

protected abstract void parameters_save(ParametersString buffer)

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

reset

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

exec

public boolean exec(Object sender,
                    String command,
                    Object info)

Description copied from interface: INotifiable

Sends a command for the object to react

Specified by:

exec in interface INotifiable

command - a string identifying the command

info - command-specific object

Returns:

true if command has been executed and doesn't need to be sent on

loadGroup

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

loadGroup

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

saveGroup

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

saveGroup

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

loadFromResource

public boolean loadFromResource(String resourceLocation)

loadFromResource

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

saveToResource

public void saveToResource(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