Parameters (Okapi Framework SDK 1.41.0 API)

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

All Implemented Interfaces:: IParameters, IEditorDescriptionProvider

public class Parameters
extends StringParameters
implements IEditorDescriptionProvider

Field Summary
- Fields inherited from class net.sf.okapi.common.StringParameters
  buffer
- Fields inherited from class net.sf.okapi.common.BaseParameters
  path

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
`EditorDescription`	`createEditorDescription(ParametersDescription paramsDesc)`
`void`	`fromString(String data)` Reset this parameters object to its default values and then load additional parameters from the provided data.
`String`	`getCharacterBaselineShiftMaxIgnoranceThreshold()`
`String`	`getCharacterBaselineShiftMinIgnoranceThreshold()`
`String`	`getCharacterKerningMaxIgnoranceThreshold()`
`String`	`getCharacterKerningMinIgnoranceThreshold()`
`String`	`getCharacterLeadingMaxIgnoranceThreshold()`
`String`	`getCharacterLeadingMinIgnoranceThreshold()`
`String`	`getCharacterTrackingMaxIgnoranceThreshold()`
`String`	`getCharacterTrackingMinIgnoranceThreshold()`
`boolean`	`getExtractBreaksInline()`
`boolean`	`getExtractHiddenLayers()`
`boolean`	`getExtractHiddenPasteboardItems()`
`boolean`	`getExtractMasterSpreads()`
`boolean`	`getExtractNotes()`
`boolean`	`getIgnoreCharacterBaselineShift()`
`boolean`	`getIgnoreCharacterKerning()`
`boolean`	`getIgnoreCharacterLeading()`
`boolean`	`getIgnoreCharacterTracking()`
`int`	`getMaxAttributeSize()`
`ParametersDescription`	`getParametersDescription()` Gets the description of the parameters.
`boolean`	`getSkipDiscretionaryHyphens()`
`boolean`	`getUntagXmlStructures()`
`void`	`reset()` Reset this parameters object to its default values.
`void`	`setCharacterBaselineShiftMaxIgnoranceThreshold(String threshold)`
`void`	`setCharacterBaselineShiftMinIgnoranceThreshold(String threshold)`
`void`	`setCharacterKerningMaxIgnoranceThreshold(String threshold)`
`void`	`setCharacterKerningMinIgnoranceThreshold(String threshold)`
`void`	`setCharacterLeadingMaxIgnoranceThreshold(String threshold)`
`void`	`setCharacterLeadingMinIgnoranceThreshold(String threshold)`
`void`	`setCharacterTrackingMaxIgnoranceThreshold(String threshold)`
`void`	`setCharacterTrackingMinIgnoranceThreshold(String threshold)`
`void`	`setExtractBreaksInline(boolean extractBreaksInline)`
`void`	`setExtractHiddenLayers(boolean extractHiddenLayers)`
`void`	`setExtractHiddenPasteboardItems(boolean extractHiddenPasteboardItems)`
`void`	`setExtractMasterSpreads(boolean extractMasterSpreads)`
`void`	`setExtractNotes(boolean extractNotes)`
`void`	`setIgnoreCharacterBaselineShift(boolean ignore)`
`void`	`setIgnoreCharacterKerning(boolean ignore)`
`void`	`setIgnoreCharacterLeading(boolean ignore)`
`void`	`setIgnoreCharacterTracking(boolean ignore)`
`void`	`setMaxAttributeSize(int maxAttributeSize)`
`void`	`setSkipDiscretionaryHyphens(boolean skipDiscretionaryHyphens)`
`void`	`setUntagXmlStructures(boolean untagXmlStructures)`
`String`	`toString()` Serialize this parameters object to a string.

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
getPath, load, load, save, setPath

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

- 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
  - getMaxAttributeSize
```
public int getMaxAttributeSize()
```
  - setMaxAttributeSize
```
public void setMaxAttributeSize(int maxAttributeSize)
```
  - getUntagXmlStructures
```
public boolean getUntagXmlStructures()
```
  - setUntagXmlStructures
```
public void setUntagXmlStructures(boolean untagXmlStructures)
```
  - getExtractNotes
```
public boolean getExtractNotes()
```
  - setExtractNotes
```
public void setExtractNotes(boolean extractNotes)
```
  - getExtractMasterSpreads
```
public boolean getExtractMasterSpreads()
```
  - setExtractMasterSpreads
```
public void setExtractMasterSpreads(boolean extractMasterSpreads)
```
  - getExtractHiddenLayers
```
public boolean getExtractHiddenLayers()
```
  - setExtractHiddenLayers
```
public void setExtractHiddenLayers(boolean extractHiddenLayers)
```
  - getExtractHiddenPasteboardItems
```
public boolean getExtractHiddenPasteboardItems()
```
  - setExtractHiddenPasteboardItems
```
public void setExtractHiddenPasteboardItems(boolean extractHiddenPasteboardItems)
```
  - setSkipDiscretionaryHyphens
```
public void setSkipDiscretionaryHyphens(boolean skipDiscretionaryHyphens)
```
  - getSkipDiscretionaryHyphens
```
public boolean getSkipDiscretionaryHyphens()
```
  - setExtractBreaksInline
```
public void setExtractBreaksInline(boolean extractBreaksInline)
```
  - getExtractBreaksInline
```
public boolean getExtractBreaksInline()
```
  - getIgnoreCharacterKerning
```
public boolean getIgnoreCharacterKerning()
```
  - setIgnoreCharacterKerning
```
public void setIgnoreCharacterKerning(boolean ignore)
```
  - getCharacterKerningMinIgnoranceThreshold
```
public String getCharacterKerningMinIgnoranceThreshold()
```
  - setCharacterKerningMinIgnoranceThreshold
```
public void setCharacterKerningMinIgnoranceThreshold(String threshold)
```
  - getCharacterKerningMaxIgnoranceThreshold
```
public String getCharacterKerningMaxIgnoranceThreshold()
```
  - setCharacterKerningMaxIgnoranceThreshold
```
public void setCharacterKerningMaxIgnoranceThreshold(String threshold)
```
  - getIgnoreCharacterTracking
```
public boolean getIgnoreCharacterTracking()
```
  - setIgnoreCharacterTracking
```
public void setIgnoreCharacterTracking(boolean ignore)
```
  - getCharacterTrackingMinIgnoranceThreshold
```
public String getCharacterTrackingMinIgnoranceThreshold()
```
  - setCharacterTrackingMinIgnoranceThreshold
```
public void setCharacterTrackingMinIgnoranceThreshold(String threshold)
```
  - getCharacterTrackingMaxIgnoranceThreshold
```
public String getCharacterTrackingMaxIgnoranceThreshold()
```
  - setCharacterTrackingMaxIgnoranceThreshold
```
public void setCharacterTrackingMaxIgnoranceThreshold(String threshold)
```
  - getIgnoreCharacterLeading
```
public boolean getIgnoreCharacterLeading()
```
  - setIgnoreCharacterLeading
```
public void setIgnoreCharacterLeading(boolean ignore)
```
  - getCharacterLeadingMinIgnoranceThreshold
```
public String getCharacterLeadingMinIgnoranceThreshold()
```
  - setCharacterLeadingMinIgnoranceThreshold
```
public void setCharacterLeadingMinIgnoranceThreshold(String threshold)
```
  - getCharacterLeadingMaxIgnoranceThreshold
```
public String getCharacterLeadingMaxIgnoranceThreshold()
```
  - setCharacterLeadingMaxIgnoranceThreshold
```
public void setCharacterLeadingMaxIgnoranceThreshold(String threshold)
```
  - getIgnoreCharacterBaselineShift
```
public boolean getIgnoreCharacterBaselineShift()
```
  - setIgnoreCharacterBaselineShift
```
public void setIgnoreCharacterBaselineShift(boolean ignore)
```
  - getCharacterBaselineShiftMinIgnoranceThreshold
```
public String getCharacterBaselineShiftMinIgnoranceThreshold()
```
  - setCharacterBaselineShiftMinIgnoranceThreshold
```
public void setCharacterBaselineShiftMinIgnoranceThreshold(String threshold)
```
  - getCharacterBaselineShiftMaxIgnoranceThreshold
```
public String getCharacterBaselineShiftMaxIgnoranceThreshold()
```
  - setCharacterBaselineShiftMaxIgnoranceThreshold
```
public void setCharacterBaselineShiftMaxIgnoranceThreshold(String threshold)
```
  - getParametersDescription
```
public ParametersDescription getParametersDescription()
```
    Description copied from interface: IParameters
    
    Gets the description of the parameters.
    
    Specified by:
    
    getParametersDescription in interface IParameters
    
    Overrides:
    
    getParametersDescription in class BaseParameters
    
    Returns:
    
    the ParametersDescription object for this set of parameters, or null if none is provided.
  - createEditorDescription
```
public EditorDescription createEditorDescription(ParametersDescription paramsDesc)
```
    Specified by:
    
    createEditorDescription in interface IEditorDescriptionProvider
  - 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.

Class Parameters

Field Summary

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

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

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

Constructor Detail

Parameters

Method Detail

reset

getMaxAttributeSize

setMaxAttributeSize

getUntagXmlStructures

setUntagXmlStructures

getExtractNotes

setExtractNotes

getExtractMasterSpreads

setExtractMasterSpreads

getExtractHiddenLayers

setExtractHiddenLayers

getExtractHiddenPasteboardItems

setExtractHiddenPasteboardItems

setSkipDiscretionaryHyphens

getSkipDiscretionaryHyphens

setExtractBreaksInline

getExtractBreaksInline

getIgnoreCharacterKerning

setIgnoreCharacterKerning

getCharacterKerningMinIgnoranceThreshold

setCharacterKerningMinIgnoranceThreshold

getCharacterKerningMaxIgnoranceThreshold

setCharacterKerningMaxIgnoranceThreshold

getIgnoreCharacterTracking

setIgnoreCharacterTracking

getCharacterTrackingMinIgnoranceThreshold

setCharacterTrackingMinIgnoranceThreshold

getCharacterTrackingMaxIgnoranceThreshold

setCharacterTrackingMaxIgnoranceThreshold

getIgnoreCharacterLeading

setIgnoreCharacterLeading

getCharacterLeadingMinIgnoranceThreshold

setCharacterLeadingMinIgnoranceThreshold

getCharacterLeadingMaxIgnoranceThreshold

setCharacterLeadingMaxIgnoranceThreshold

getIgnoreCharacterBaselineShift

setIgnoreCharacterBaselineShift

getCharacterBaselineShiftMinIgnoranceThreshold

setCharacterBaselineShiftMinIgnoranceThreshold

getCharacterBaselineShiftMaxIgnoranceThreshold

setCharacterBaselineShiftMaxIgnoranceThreshold

getParametersDescription

createEditorDescription

fromString

toString