net.sf.okapi.filters.plaintext.regex

Class Parameters

java.lang.Object

net.sf.okapi.common.BaseParameters

net.sf.okapi.common.StringParameters

net.sf.okapi.common.AbstractGroupParameters

net.sf.okapi.filters.plaintext.base.Parameters

net.sf.okapi.filters.plaintext.regex.Parameters

All Implemented Interfaces:

IParameters, ISimplifierRulesParameters

public class Parameters
extends Parameters

Parameters of the Regex Plain Text Filter

Version:

0.1, 09.06.2009

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEF_GROUP
static int	DEF_OPTIONS
static String	DEF_RULE
static String	DEF_SAMPLE
int	regexOptions Java regex options.
String	rule Java regex rule used to extract lines of text.
String	sample Sample text for the rule.
int	sourceGroup Java regex capturing group denoting text to be extracted.

Fields inherited from class net.sf.okapi.filters.plaintext.base.Parameters

codeFinderRules, preserveWS, subfilter, trimLeading, trimTrailing, unescapeSource, useCodeFinder, wrapMode

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
protected void	load(ParametersString buffer) Load from buffer.
void	reset() Reset this parameters object to its default values.
protected void	save(ParametersString buffer) Save to buffer.

Methods inherited from class net.sf.okapi.common.AbstractGroupParameters

fromString, getData, getSimplifierRules, loadFromResource, loadGroup, loadGroup, saveGroup, saveGroup, saveToResource, setSimplifierRules, toString, validateSimplifierRules

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

DEF_RULE

public static final String DEF_RULE

See Also:

Constant Field Values

DEF_GROUP

public static final int DEF_GROUP

See Also:

Constant Field Values

DEF_SAMPLE

public static final String DEF_SAMPLE

See Also:

Constant Field Values

DEF_OPTIONS

public static final int DEF_OPTIONS

See Also:

Constant Field Values

rule

public String rule

Java regex rule used to extract lines of text.

Default: "(^(?=.+))(.*?)$".

sourceGroup

public int sourceGroup

Java regex capturing group denoting text to be extracted.

Default: 2.

regexOptions

public int regexOptions

Java regex options.

Default: Pattern.MULTILINE.

sample

public String sample

Sample text for the rule.

Constructor Detail

Parameters

public Parameters()

Method Detail

load

protected void load(ParametersString buffer)

Description copied from class: AbstractGroupParameters

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

Overrides:

load in class Parameters

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 Parameters

save

protected void save(ParametersString buffer)

Description copied from class: AbstractGroupParameters

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

Overrides:

save in class Parameters