Package net.sf.okapi.filters.xliff2

Class Parameters

java.lang.Object

net.sf.okapi.common.BaseParameters

net.sf.okapi.common.StringParameters

net.sf.okapi.filters.xliff2.Parameters

All Implemented Interfaces:

IParameters, IEditorDescriptionProvider

public class Parameters
extends StringParameters
implements IEditorDescriptionProvider

Field Summary

Fields

Modifier and Type	Field	Description
static String	MAXVALIDATION
static String	MERGE_AS_PARAGRAPH	Deprecated.

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

Modifier and Type	Method	Description
EditorDescription	createEditorDescription(ParametersDescription paramDesc)
void	fromString(String data)	Reset this parameters object to its default values and then load additional parameters from the provided data.
InlineCodeFinder	getCodeFinder()
String	getCodeFinderData()
boolean	getMaxValidation()
boolean	getMergeAsParagraph()	Deprecated.
boolean	getNeedsSegmentation()
ParametersDescription	getParametersDescription()	Gets the description of the parameters.
boolean	getSimplifyTags()
boolean	getUseCodeFinder()
void	reset()	Reset this parameters object to its default values.
void	setCodeFinderData(String data)
void	setMaxValidation(boolean maxValidation)
void	setMergeAsParagraph(boolean mergeAsParagraph)	Deprecated.
void	setNeedsSegmentation(boolean needsSegmentation)
void	setSimplifyTags(boolean simplifyTags)
void	setUseCodeFinder(boolean useCodeFinder)
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

Field Detail

MAXVALIDATION

public static final String MAXVALIDATION

See Also:

Constant Field Values

MERGE_AS_PARAGRAPH

@Deprecated
public static final String MERGE_AS_PARAGRAPH

Deprecated.

See Also:

Constant Field Values

Constructor Detail

Parameters

public Parameters()

Method Detail

getMaxValidation

public boolean getMaxValidation()

setMaxValidation

public void setMaxValidation(boolean maxValidation)

getMergeAsParagraph

@Deprecated
public boolean getMergeAsParagraph()

Deprecated.

setMergeAsParagraph

@Deprecated
public void setMergeAsParagraph(boolean mergeAsParagraph)

Deprecated.

getUseCodeFinder

public boolean getUseCodeFinder()

setUseCodeFinder

public void setUseCodeFinder(boolean useCodeFinder)

getCodeFinder

public InlineCodeFinder getCodeFinder()

getCodeFinderData

public String getCodeFinderData()

setCodeFinderData

public void setCodeFinderData(String data)

getSimplifyTags

public boolean getSimplifyTags()

setSimplifyTags

public void setSimplifyTags(boolean simplifyTags)

getNeedsSegmentation

public boolean getNeedsSegmentation()

setNeedsSegmentation

public void setNeedsSegmentation(boolean needsSegmentation)

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

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.

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 paramDesc)

Specified by:

createEditorDescription in interface IEditorDescriptionProvider