java.lang.Object
- net.sf.okapi.common.BaseParameters
- - net.sf.okapi.common.StringParameters
  - - net.sf.okapi.filters.regex.Parameters

All Implemented Interfaces:: Cloneable, IParameters, ISimplifierRulesParameters

public class Parameters
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

Parameters()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`compileRules()`
`void`	`fromString(String data)`	Reset this parameters object to its default values and then load additional parameters from the provided data.
`String`	`getEndString()`
`boolean`	`getExtractOuterStrings()`
`LocalizationDirectives`	`getLocalizationDirectives()`
`ArrayList<MetaRule>`	`getMetaRules()`
`String`	`getMimeType()`
`boolean`	`getOneLevelGroups()`
`int`	`getRegexOptions()`
`boolean`	`getRemoveBSlashEscape()`
`ArrayList<Rule>`	`getRules()`
`String`	`getSimplifierRules()`	Get the code simplifier rules as defined by `SimplifierRules` (JavaCC file: core/simplifierrules/SimplifierRules.jj).
`String`	`getStartString()`
`String`	`getSubFilter()`
`boolean`	`getUseBSlashEscape()`
`boolean`	`getUseDoubleCharEscape()`
`void`	`reset()`	Reset this parameters object to its default values.
`void`	`setEndString(String endString)`
`void`	`setExtractOuterStrings(boolean extractOuterStrings)`
`void`	`setLocalizationDirectives(LocalizationDirectives localizationDirectives)`
`void`	`setMimeType(String mimeType)`
`void`	`setOneLevelGroups(boolean oneLevelGroups)`
`void`	`setRegexOptions(int regexOptions)`
`void`	`setRemoveBSlashEscape(boolean removeBSlashEscape)`
`void`	`setSimplifierRules(String rules)`	Set the simplifier rules.
`void`	`setStartString(String startString)`
`void`	`setSubFilter(String subfilter)`
`void`	`setUseBSlashEscape(boolean useBSlashEscape)`
`void`	`setUseDoubleCharEscape(boolean useDoubleCharEscape)`
`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

Methods inherited from interface net.sf.okapi.common.IParameters
copy

- 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
  - getExtractOuterStrings
```
public boolean getExtractOuterStrings()
```
  - setExtractOuterStrings
```
public void setExtractOuterStrings(boolean extractOuterStrings)
```
  - getStartString
```
public String getStartString()
```
  - setStartString
```
public void setStartString(String startString)
```
  - getEndString
```
public String getEndString()
```
  - setEndString
```
public void setEndString(String endString)
```
  - getUseBSlashEscape
```
public boolean getUseBSlashEscape()
```
  - setUseBSlashEscape
```
public void setUseBSlashEscape(boolean useBSlashEscape)
```
  - getUseDoubleCharEscape
```
public boolean getUseDoubleCharEscape()
```
  - setUseDoubleCharEscape
```
public void setUseDoubleCharEscape(boolean useDoubleCharEscape)
```
  - getRemoveBSlashEscape
```
public boolean getRemoveBSlashEscape()
```
  - setRemoveBSlashEscape
```
public void setRemoveBSlashEscape(boolean removeBSlashEscape)
```
  - getRegexOptions
```
public int getRegexOptions()
```
  - setRegexOptions
```
public void setRegexOptions(int regexOptions)
```
  - getLocalizationDirectives
```
public LocalizationDirectives getLocalizationDirectives()
```
  - setLocalizationDirectives
```
public void setLocalizationDirectives(LocalizationDirectives localizationDirectives)
```
  - getMimeType
```
public String getMimeType()
```
  - setMimeType
```
public void setMimeType(String mimeType)
```
  - getOneLevelGroups
```
public boolean getOneLevelGroups()
```
  - setOneLevelGroups
```
public void setOneLevelGroups(boolean oneLevelGroups)
```
  - 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 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.
  - compileRules
```
public void compileRules()
```
  - getRules
```
public ArrayList<Rule> getRules()
```
  - getMetaRules
```
public ArrayList<MetaRule> getMetaRules()
```
  - 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
  - getSubFilter
```
public String getSubFilter()
```
  - setSubFilter
```
public void setSubFilter(String subfilter)
```

Class Parameters

Field Summary

Fields inherited from class net.sf.okapi.common.StringParameters

Fields inherited from class net.sf.okapi.common.BaseParameters

Fields inherited from interface net.sf.okapi.common.ISimplifierRulesParameters

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface net.sf.okapi.common.IParameters

Constructor Detail

Parameters

Method Detail

reset

getExtractOuterStrings

setExtractOuterStrings

getStartString

setStartString

getEndString

setEndString

getUseBSlashEscape

setUseBSlashEscape

getUseDoubleCharEscape

setUseDoubleCharEscape

getRemoveBSlashEscape

setRemoveBSlashEscape

getRegexOptions

setRegexOptions

getLocalizationDirectives

setLocalizationDirectives

getMimeType

setMimeType

getOneLevelGroups

setOneLevelGroups

fromString

toString

compileRules

getRules

getMetaRules

getSimplifierRules

setSimplifierRules

validateSimplifierRules

getSubFilter

setSubFilter