Package net.sf.okapi.steps.formatconversion

Class Parameters

java.lang.Object

net.sf.okapi.common.BaseParameters

net.sf.okapi.common.StringParameters

net.sf.okapi.steps.formatconversion.Parameters

All Implemented Interfaces:

IParameters, IEditorDescriptionProvider

public class Parameters
extends StringParameters
implements IEditorDescriptionProvider

Field Summary

Fields

Modifier and Type	Field	Description
static String	FORMAT_CORPUS
static String	FORMAT_PENSIEVE
static String	FORMAT_PO
static String	FORMAT_TABLE
static String	FORMAT_TMX
static String	FORMAT_WORDTABLE
static String	FORMAT_XLIFF
static int	TRG_FORCEEMPTY
static int	TRG_FORCESOURCE
static int	TRG_TARGETOREMPTY

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)
boolean	getApprovedEntriesOnly()
boolean	getAutoExtensions()
String	getFormatOptions()
String	getOutputFormat()
String	getOutputPath()
boolean	getOverwriteSameSource()
ParametersDescription	getParametersDescription()	Gets the description of the parameters.
boolean	getSingleOutput()
boolean	getSkipEntriesWithoutText()
int	getTargetStyle()
boolean	getUseGenericCodes()
IFilterWriter	getWriter()
void	reset()	Reset this parameters object to its default values.
void	setApprovedEntriesOnly(boolean approvedEntriesOnly)
void	setAutoExtensions(boolean autoExtensions)
void	setFormatOptions(String formatOptions)
void	setOutputFormat(String outputFormat)
void	setOutputPath(String outputPath)
void	setOverwriteSameSource(boolean overwriteSameSource)
void	setSingleOutput(boolean singleOutput)
void	setSkipEntriesWithoutText(boolean skipEntriesWithoutText)
void	setTargetStyle(int targetStyle)
void	setUseGenericCodes(boolean useGenericCodes)
void	setWriter(IFilterWriter writer)

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

getPath, load, load, save, setPath

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FORMAT_TMX

public static final String FORMAT_TMX

See Also:

Constant Field Values

FORMAT_PO

public static final String FORMAT_PO

See Also:

Constant Field Values

FORMAT_TABLE

public static final String FORMAT_TABLE

See Also:

Constant Field Values

FORMAT_PENSIEVE

public static final String FORMAT_PENSIEVE

See Also:

Constant Field Values

FORMAT_CORPUS

public static final String FORMAT_CORPUS

See Also:

Constant Field Values

FORMAT_WORDTABLE

public static final String FORMAT_WORDTABLE

See Also:

Constant Field Values

FORMAT_XLIFF

public static final String FORMAT_XLIFF

See Also:

Constant Field Values

TRG_TARGETOREMPTY

public static final int TRG_TARGETOREMPTY

See Also:

Constant Field Values

TRG_FORCESOURCE

public static final int TRG_FORCESOURCE

See Also:

Constant Field Values

TRG_FORCEEMPTY

public static final int TRG_FORCEEMPTY

See Also:

Constant Field Values

Constructor Detail

Parameters

public Parameters()

Method Detail

getTargetStyle

public int getTargetStyle()

setTargetStyle

public void setTargetStyle(int targetStyle)

getSingleOutput

public boolean getSingleOutput()

setSingleOutput

public void setSingleOutput(boolean singleOutput)

getAutoExtensions

public boolean getAutoExtensions()

setAutoExtensions

public void setAutoExtensions(boolean autoExtensions)

getOutputPath

public String getOutputPath()

setOutputPath

public void setOutputPath(String outputPath)

getOutputFormat

public String getOutputFormat()

setOutputFormat

public void setOutputFormat(String outputFormat)

getUseGenericCodes

public boolean getUseGenericCodes()

setUseGenericCodes

public void setUseGenericCodes(boolean useGenericCodes)

getFormatOptions

public String getFormatOptions()

setFormatOptions

public void setFormatOptions(String formatOptions)

getSkipEntriesWithoutText

public boolean getSkipEntriesWithoutText()

setSkipEntriesWithoutText

public void setSkipEntriesWithoutText(boolean skipEntriesWithoutText)

getApprovedEntriesOnly

public boolean getApprovedEntriesOnly()

setApprovedEntriesOnly

public void setApprovedEntriesOnly(boolean approvedEntriesOnly)

getOverwriteSameSource

public boolean getOverwriteSameSource()

setOverwriteSameSource

public void setOverwriteSameSource(boolean overwriteSameSource)

getWriter

public IFilterWriter getWriter()

Returns:

the writer

setWriter

public void setWriter(IFilterWriter writer)

Parameters:

writer - the writer to set

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

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