Parameters (Okapi Step for Text Transliteration 1.46.0 API)

java.lang.Object
- net.sf.okapi.common.BaseParameters
- - net.sf.okapi.common.StringParameters
  - - net.sf.okapi.steps.transliteration.Parameters

All Implemented Interfaces:

Cloneable, IParameters
```
public class Parameters
extends StringParameters
```
Use cases (let's take sr-Cyrl to sr-Latn transliteration)
- take the source and "translate" (transliterate) it into target
  (source locale should be sr-Cyrl, target locale should be sr-Latn)
- take an existing target and convert in place (but then the target locale is wrong, or was wrong)
  (source locale could be anything, a sr-Cyrl (or sr-Latn?) target should already exist)
- take an existing target and create a new target with a new locale
  (source locale could be anything, a sr-Cyrl target locale should already exist)
  - override new target locale (sr-Latn) if it exists already (boolean)
  - remove / keep the original target locale (sr-Cyrl)

Field Summary

Fields
Modifier and Type Field Description

static String NO_TRANSLITERATION
- Fields inherited from class net.sf.okapi.common.StringParameters
  buffer
- Fields inherited from class net.sf.okapi.common.BaseParameters
  path

Constructor Summary

Constructors
Constructor Description

Parameters()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`LocaleId`	`getFromTargetLocale()`
`String`	`getIcuTransliteratorId()`
`LocaleId`	`getToTargetLocale()`
`boolean`	`isValid()`
`void`	`reset()`
`void`	`setFromTargetLocale(LocaleId fromTargetLocale)`
`boolean`	`setIcuTransliteratorId(String icuTransliteratorId)`
`void`	`setToTargetLocale(LocaleId toTargetLocale)`

Methods inherited from class net.sf.okapi.common.StringParameters
fromString, fromString, getBoolean, getGroup, getInteger, getString, setBoolean, setGroup, setInteger, setString, toString

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

Field Detail
- NO_TRANSLITERATION
```
public static final String NO_TRANSLITERATION
```
  See Also:
  
  Constant Field Values

Constructor Detail
- Parameters
```
public Parameters()
```

Method Detail

getIcuTransliteratorId

public String getIcuTransliteratorId()

getFromTargetLocale
```
public LocaleId getFromTargetLocale()
```

getToTargetLocale
```
public LocaleId getToTargetLocale()
```

setIcuTransliteratorId

public boolean setIcuTransliteratorId(String icuTransliteratorId)

setFromTargetLocale

public void setFromTargetLocale(LocaleId fromTargetLocale)

setToTargetLocale

public void setToTargetLocale(LocaleId toTargetLocale)

reset
```
public void reset()
```
Specified by:

reset in interface IParameters

Overrides:

reset in class StringParameters

isValid
```
public boolean isValid()
```