Package net.sf.okapi.steps.wordcount.common

Class Parameters

java.lang.Object

net.sf.okapi.common.BaseParameters

net.sf.okapi.common.StringParameters

net.sf.okapi.common.AbstractGroupParameters

net.sf.okapi.steps.wordcount.common.Parameters

All Implemented Interfaces:

IParameters, ISimplifierRulesParameters, IEditorDescriptionProvider

public class Parameters
extends AbstractGroupParameters
implements IEditorDescriptionProvider

Field Summary

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

buffer

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

path

Fields inherited from interface net.sf.okapi.common.ISimplifierRulesParameters

SIMPLIFIERRULES, SIMPLIFIERRULES_DISPLAY_NAME, SIMPLIFIERRULES_SHORT_DESC

Constructor Summary

Constructors

Constructor	Description
Parameters()

Method Summary

Modifier and Type	Method	Description
EditorDescription	createEditorDescription(ParametersDescription paramsDesc)
int	getBufferSize()
boolean	getCountInBatch()
boolean	getCountInBatchItems()
boolean	getCountInDocuments()
boolean	getCountInGroups()
boolean	getCountInSubDocuments()
boolean	getCountInTextUnits()
ParametersDescription	getParametersDescription()	Gets the description of the parameters.
protected void	load(ParametersString buffer)	Load from buffer.
void	reset()	Reset this parameters object to its default values.
protected void	save(ParametersString buffer)	Save to buffer.
void	setBufferSize(int bufferSize)
void	setCountInBatch(boolean countInBatch)
void	setCountInBatchItems(boolean countInBatchItems)
void	setCountInDocuments(boolean countInDocuments)
void	setCountInGroups(boolean countInGroups)
void	setCountInSubDocuments(boolean countInSubDocuments)

Methods inherited from class net.sf.okapi.common.AbstractGroupParameters

fromString, getData, getSimplifierRules, loadFromResource, loadGroup, loadGroup, saveGroup, saveGroup, saveToResource, setSimplifierRules, toString, validateSimplifierRules

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

getCountInBatch

public boolean getCountInBatch()

setCountInBatch

public void setCountInBatch(boolean countInBatch)

getCountInBatchItems

public boolean getCountInBatchItems()

setCountInBatchItems

public void setCountInBatchItems(boolean countInBatchItems)

getCountInDocuments

public boolean getCountInDocuments()

setCountInDocuments

public void setCountInDocuments(boolean countInDocuments)

getCountInSubDocuments

public boolean getCountInSubDocuments()

setCountInSubDocuments

public void setCountInSubDocuments(boolean countInSubDocuments)

getCountInGroups

public boolean getCountInGroups()

setCountInGroups

public void setCountInGroups(boolean countInGroups)

getCountInTextUnits

public boolean getCountInTextUnits()

setBufferSize

public void setBufferSize(int bufferSize)

getBufferSize

public int getBufferSize()

load

protected void load(ParametersString buffer)

Description copied from class: AbstractGroupParameters

Load from buffer. The protected buffer variable is visible in all subclasses of BaseParameters.

Specified by:

load in class AbstractGroupParameters

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

save

protected void save(ParametersString buffer)

Description copied from class: AbstractGroupParameters

Save to buffer. The protected buffer variable is visible in all subclasses of BaseParameters.

Specified by:

save in class AbstractGroupParameters

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