Parameters (Okapi Framework SDK 1.41.0 API)

java.lang.Object
- net.sf.okapi.filters.its.Parameters

All Implemented Interfaces:: IParameters

public class Parameters
extends Object
implements IParameters

Field Summary

Fields
Modifier and Type	Field and Description
`InlineCodeFinder`	`codeFinder`
`boolean`	`escapeGT`
`boolean`	`escapeLineBreak`
`boolean`	`escapeNbsp`
`boolean`	`escapeQuotes`
`boolean`	`extractIfOnlyCodes`
`boolean`	`inlineCdata`
`boolean`	`lineBreakAsCode`
`boolean`	`mapAnnotations`
`boolean`	`omitXMLDeclaration`
`boolean`	`protectEntityRef`
`int`	`quoteMode`
`boolean`	`quoteModeDefined`
`String`	`simplifierRules`
`boolean`	`useCodeFinder`

Constructor Summary

Constructors
Constructor and Description

Parameters()

Constructors
Constructor and Description
`Parameters()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`fromString(String data)` Parses the parameters stored into a string back into the object.
`boolean`	`getBoolean(String name)` Gets the boolean value for the given parameter name.
`Document`	`getDocument()`
`int`	`getInteger(String name)` Gets the integer value for a given parameter name.
`ParametersDescription`	`getParametersDescription()` Gets the description of the parameters.
`String`	`getPath()` Gets the full path of the last file where the parameters where loaded from or saved to.
`String`	`getSimplifierRules()`
`String`	`getString(String name)` Gets the string value for a given parameter name.
`URI`	`getURI()`
`void`	`load(InputStream inStream, boolean ignoreErrors)` Loads the parameters from a file.
`void`	`load(URL inputURL, boolean ignoreErrors)` Loads the parameters from a file.
`void`	`reset()` Reset the parameters to their default values.
`void`	`save(String filePath)` Saves the parameters to a file.
`void`	`setBoolean(String name, boolean value)` Sets the boolean value for a given parameter name.
`void`	`setInteger(String name, int value)` Sets the integer value for a given parameter name.
`void`	`setPath(String filePath)` Sets the full path of the file where the parameters are to be saved to.
`void`	`setSimplifierRules(String simplifierRules)`
`void`	`setString(String name, String value)` Sets the string value for a given parameter name.
`String`	`toString()` Converts the parameters into a string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - useCodeFinder
```
public boolean useCodeFinder
```
  - codeFinder
```
public InlineCodeFinder codeFinder
```
  - escapeGT
```
public boolean escapeGT
```
  - escapeNbsp
```
public boolean escapeNbsp
```
  - protectEntityRef
```
public boolean protectEntityRef
```
  - escapeLineBreak
```
public boolean escapeLineBreak
```
  - lineBreakAsCode
```
public boolean lineBreakAsCode
```
  - omitXMLDeclaration
```
public boolean omitXMLDeclaration
```
  - escapeQuotes
```
public boolean escapeQuotes
```
  - extractIfOnlyCodes
```
public boolean extractIfOnlyCodes
```
  - mapAnnotations
```
public boolean mapAnnotations
```
  - inlineCdata
```
public boolean inlineCdata
```
  - quoteModeDefined
```
public boolean quoteModeDefined
```
  - quoteMode
```
public int quoteMode
```
  - simplifierRules
```
public String simplifierRules
```
- Constructor Detail
  - Parameters
```
public Parameters()
```
- Method Detail
  - toString
```
public String toString()
```
    Description copied from interface: IParameters
    
    Converts the parameters into a string.
    
    Specified by:
    
    toString in interface IParameters
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the string holding all the parameters.
  - fromString
```
public void fromString(String data)
```
    Description copied from interface: IParameters
    
    Parses the parameters stored into a string back into the object.
    
    Specified by:
    
    fromString in interface IParameters
    
    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.
  - getPath
```
public String getPath()
```
    Description copied from interface: IParameters
    
    Gets the full path of the last file where the parameters where loaded from or saved to.
    
    Specified by:
    
    getPath in interface IParameters
    
    Returns:
    
    the full path of the last load() or save(), or null if object was not loaded nor saved.
  - setPath
```
public void setPath(String filePath)
```
    Description copied from interface: IParameters
    
    Sets the full path of the file where the parameters are to be saved to.
    
    Specified by:
    
    setPath in interface IParameters
    
    Parameters:
    
    filePath - the full path to set.
  - load
```
public void load(URL inputURL,
                 boolean ignoreErrors)
```
    Description copied from interface: IParameters
    
    Loads the parameters from a file.
    
    Specified by:
    
    load in interface IParameters
    
    Parameters:
    
    inputURL - URL of the parameters file to load.
    
    ignoreErrors - true if the load should ignore any error such as file not found. If an error occurs and this is set to true, the method should create the parameters object with its default values.
  - load
```
public void load(InputStream inStream,
                 boolean ignoreErrors)
```
    Description copied from interface: IParameters
    
    Loads the parameters from a file.
    
    Specified by:
    
    load in interface IParameters
    
    Parameters:
    
    inStream - input stream with the parameters to load.
    
    ignoreErrors - true if the load should ignore any error such as file not found. If an error occurs and this is set to true, the method should create the parameters object with its default values.
  - reset
```
public void reset()
```
    Description copied from interface: IParameters
    
    Reset the parameters to their default values.
    
    Specified by:
    
    reset in interface IParameters
  - save
```
public void save(String filePath)
```
    Description copied from interface: IParameters
    
    Saves the parameters to a file.
    
    Specified by:
    
    save in interface IParameters
    
    Parameters:
    
    filePath - the full path of the parameters file to save.
  - getDocument
```
public Document getDocument()
```
  - getURI
```
public URI getURI()
```
  - getBoolean
```
public boolean getBoolean(String name)
```
    Description copied from interface: IParameters
    
    Gets the boolean value for the given parameter name.
    
    Specified by:
    
    getBoolean in interface IParameters
    
    Parameters:
    
    name - the name of the boolean parameter to retrieve.
    
    Returns:
    
    the value of the given parameter, or false if it is not defined.
  - setBoolean
```
public void setBoolean(String name,
                       boolean value)
```
    Description copied from interface: IParameters
    
    Sets the boolean value for a given parameter name.
    
    Specified by:
    
    setBoolean in interface IParameters
    
    Parameters:
    
    name - the name of the parameter to set.
    
    value - the new value to set.
  - getString
```
public String getString(String name)
```
    Description copied from interface: IParameters
    
    Gets the string value for a given parameter name.
    
    Specified by:
    
    getString in interface IParameters
    
    Parameters:
    
    name - the name of the string parameter to retrieve.
    
    Returns:
    
    the value of the given parameter, or null if it is not defined.
  - setString
```
public void setString(String name,
                      String value)
```
    Description copied from interface: IParameters
    
    Sets the string value for a given parameter name.
    
    Specified by:
    
    setString in interface IParameters
    
    Parameters:
    
    name - the name of the parameter to set.
    
    value - the new value to set.
  - getInteger
```
public int getInteger(String name)
```
    Description copied from interface: IParameters
    
    Gets the integer value for a given parameter name.
    
    Specified by:
    
    getInteger in interface IParameters
    
    Parameters:
    
    name - the name of the integer parameter to retrieve.
    
    Returns:
    
    the value of the given parameter, or 0 if it is not defined.
  - setInteger
```
public void setInteger(String name,
                       int value)
```
    Description copied from interface: IParameters
    
    Sets the integer value for a given parameter name.
    
    Specified by:
    
    setInteger in interface IParameters
    
    Parameters:
    
    name - the name of the parameter to set.
    
    value - the new value to set.
  - getParametersDescription
```
public ParametersDescription getParametersDescription()
```
    Description copied from interface: IParameters
    
    Gets the description of the parameters.
    
    Specified by:
    
    getParametersDescription in interface IParameters
    
    Returns:
    
    the ParametersDescription object for this set of parameters, or null if none is provided.
  - getSimplifierRules
```
public String getSimplifierRules()
```
  - setSimplifierRules
```
public void setSimplifierRules(String simplifierRules)
```

Class Parameters

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

useCodeFinder

codeFinder

escapeGT

escapeNbsp

protectEntityRef

escapeLineBreak

lineBreakAsCode

omitXMLDeclaration

escapeQuotes

extractIfOnlyCodes

mapAnnotations

inlineCdata

quoteModeDefined

quoteMode

simplifierRules

Constructor Detail

Parameters

Method Detail

toString

fromString

getPath

setPath

load

load

reset

save

getDocument

getURI

getBoolean

setBoolean

getString

setString

getInteger

setInteger

getParametersDescription

getSimplifierRules

setSimplifierRules