net.sf.okapi.steps.whitespacecorrection

Class WhitespaceCorrectionStepParameters

java.lang.Object

net.sf.okapi.common.BaseParameters

net.sf.okapi.common.StringParameters

net.sf.okapi.steps.whitespacecorrection.WhitespaceCorrectionStepParameters

All Implemented Interfaces:

IParameters, IEditorDescriptionProvider

public class WhitespaceCorrectionStepParameters
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
WhitespaceCorrectionStepParameters()

Method Summary

Modifier and Type	Method and 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.
boolean	getComma()
boolean	getExclamationPoint()
boolean	getFullStop()
boolean	getHorizontalTabs()
boolean	getNonbreakingWhitespace()
boolean	getOther()
ParametersDescription	getParametersDescription() Gets the description of the parameters.
EnumSet<WhitespaceCorrector.Punctuation>	getPunctuation()
boolean	getQuestionMark()
boolean	getSpace()
boolean	getVerticalWhitespace()
EnumSet<WhitespaceCorrector.Whitespace>	getWhitespace()
void	reset() Reset this parameters object to its default values.
void	setComma(boolean value)
void	setExclamationPoint(boolean value)
void	setFullStop(boolean value)
void	setHorizontalTabs(boolean value)
void	setNonbreakingWhitespace(boolean value)
void	setOther(boolean value)
void	setPunctuation(Collection<WhitespaceCorrector.Punctuation> punctuation)
void	setQuestionMark(boolean value)
void	setSpace(boolean value)
void	setVerticalWhitespace(boolean value)
void	setWhiteSpace(Collection<WhitespaceCorrector.Whitespace> whitespace)
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

WhitespaceCorrectionStepParameters

public WhitespaceCorrectionStepParameters()

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

setWhiteSpace

public void setWhiteSpace(Collection<WhitespaceCorrector.Whitespace> whitespace)

setPunctuation

public void setPunctuation(Collection<WhitespaceCorrector.Punctuation> punctuation)

getPunctuation

public EnumSet<WhitespaceCorrector.Punctuation> getPunctuation()

getWhitespace

public EnumSet<WhitespaceCorrector.Whitespace> getWhitespace()

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.

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.

getFullStop

public boolean getFullStop()

setFullStop

public void setFullStop(boolean value)

getComma

public boolean getComma()

setComma

public void setComma(boolean value)

getExclamationPoint

public boolean getExclamationPoint()

setExclamationPoint

public void setExclamationPoint(boolean value)

getQuestionMark

public boolean getQuestionMark()

setQuestionMark

public void setQuestionMark(boolean value)

getVerticalWhitespace

public boolean getVerticalWhitespace()

setVerticalWhitespace

public void setVerticalWhitespace(boolean value)

getNonbreakingWhitespace

public boolean getNonbreakingWhitespace()

setNonbreakingWhitespace

public void setNonbreakingWhitespace(boolean value)

getHorizontalTabs

public boolean getHorizontalTabs()

setHorizontalTabs

public void setHorizontalTabs(boolean value)

getSpace

public boolean getSpace()

setSpace

public void setSpace(boolean value)

getOther

public boolean getOther()

setOther

public void setOther(boolean value)

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