net.sf.okapi.filters.table.base

Class Parameters

java.lang.Object

net.sf.okapi.common.BaseParameters

net.sf.okapi.common.StringParameters

net.sf.okapi.common.AbstractGroupParameters

net.sf.okapi.filters.plaintext.base.Parameters

net.sf.okapi.filters.table.base.Parameters

All Implemented Interfaces:

IParameters, ISimplifierRulesParameters

Direct Known Subclasses:

Parameters, Parameters, Parameters

public class Parameters
extends Parameters

Base Table Filter parameters

Version:

0.1, 09.06.2009

Field Summary

Fields

Modifier and Type	Field and Description
int	columnNamesLineNum Number of the line (1-based) containing field names (column captions).
String	commentColumns Indicates which columns contain comments.
String	commentSourceRefs Indicates which source columns the comment columns on the commentColumns list correspond to.
static int	DETECT_COLUMNS_COL_NAMES
static int	DETECT_COLUMNS_FIXED_NUMBER
static int	DETECT_COLUMNS_NONE
int	detectColumnsMode The filter can detect number of columns in the input.
int	numColumns Number of columns in the input.
int	recordIdColumn Index (1-based) of the column containing an optional record ID (or a key) of the current row in the table.
static int	SEND_COLUMNS_ALL
static int	SEND_COLUMNS_LISTED
static int	SEND_COLUMNS_NONE
static int	SEND_HEADER_ALL
static int	SEND_HEADER_COLUMN_NAMES_ONLY
static int	SEND_HEADER_NONE
int	sendColumnsMode Specifies values of which columns should be sent as text units SEND_COLUMNS_NONE = 0 - none of the columns are sent as text units SEND_COLUMNS_LISTED = 1 - only values from the columns listed in idColumns, sourceColumns, targetColumns, commentColumns will be sent SEND_COLUMNS_ALL = 2 - values from all columns will be sent.
int	sendHeaderMode If there are one or more lines containing description of the data, names of fields etc., and actual data don't start in the first line, then such first lines are considered a header, and this option specifies how to handle them: SEND_HEADER_NONE = 0 - none of the header lines are sent as text units SEND_HEADER_FIELD_NAMES_ONLY = 1 - only the values in the line specified by fieldNamesLineNum are sent as text units SEND_HEADER_ALL = 2 - values in all header lines are sent as text units
String	sourceColumns Indicates which columns contain source text.
String	sourceIdColumns Indicates which columns contain source IDs.
String	sourceIdSourceRefs Indicates which source columns the source ID columns on the sourceIdSourceRefs list correspond to.
String	sourceIdSuffixes If there is the recordIdColumn index, and a source ID for the given column is not specified in the sourceIdColumns, then the source ID for that column is compiled of the value in recordIdColumn column, and the corresponding suffix in the sourceIdSuffixes.
String	targetColumns Indicates which columns contain target text.
String	targetLanguages Indicates which languages should be used in target columns.
String	targetSourceRefs Indicates which source columns the target columns on the targetColumns list correspond to.
static int	TRIM_ALL
static int	TRIM_NONE
static int	TRIM_NONQUALIFIED_ONLY
int	trimMode Specifies how field values are trimmed of spaces: TRIM_NONE = 0 - field values are not trimmed TRIM_NONQUALIFIED_ONLY = 1 - only non-qualified field values are trimmed, leading and trailing spaces remain in qualified fields TRIM_ALL = 2 - both non-qualified and qualified field values are trimmed of leading and trailing spaces.
int	valuesStartLineNum Number of the line (1-based) where actual data start after the header.

Fields inherited from class net.sf.okapi.filters.plaintext.base.Parameters

codeFinderRules, preserveWS, subfilter, trimLeading, trimTrailing, unescapeSource, useCodeFinder, wrapMode

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 and Description
Parameters()

Method Summary

Modifier and Type	Method and Description
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.

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

getParametersDescription, getPath, load, load, save, setPath

Methods inherited from class java.lang.Object

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

Field Detail

DETECT_COLUMNS_NONE

public static final int DETECT_COLUMNS_NONE

See Also:

detectColumnsMode, Constant Field Values

DETECT_COLUMNS_COL_NAMES

public static final int DETECT_COLUMNS_COL_NAMES

See Also:

Constant Field Values

DETECT_COLUMNS_FIXED_NUMBER

public static final int DETECT_COLUMNS_FIXED_NUMBER

See Also:

Constant Field Values

SEND_HEADER_NONE

public static final int SEND_HEADER_NONE

See Also:

sendHeaderMode, Constant Field Values

SEND_HEADER_COLUMN_NAMES_ONLY

public static final int SEND_HEADER_COLUMN_NAMES_ONLY

See Also:

Constant Field Values

SEND_HEADER_ALL

public static final int SEND_HEADER_ALL

See Also:

Constant Field Values

SEND_COLUMNS_NONE

public static final int SEND_COLUMNS_NONE

See Also:

sendColumnsMode, Constant Field Values

SEND_COLUMNS_LISTED

public static final int SEND_COLUMNS_LISTED

See Also:

Constant Field Values

SEND_COLUMNS_ALL

public static final int SEND_COLUMNS_ALL

See Also:

Constant Field Values

TRIM_NONE

public static final int TRIM_NONE

See Also:

trimMode, Constant Field Values

TRIM_NONQUALIFIED_ONLY

public static final int TRIM_NONQUALIFIED_ONLY

See Also:

Constant Field Values

TRIM_ALL

public static final int TRIM_ALL

See Also:

Constant Field Values

columnNamesLineNum

public int columnNamesLineNum

Number of the line (1-based) containing field names (column captions).

Default: 0

valuesStartLineNum

public int valuesStartLineNum

Number of the line (1-based) where actual data start after the header.

Default: 1

detectColumnsMode

public int detectColumnsMode

The filter can detect number of columns in the input. This option specifies the way of columns number detection:

DETECT_COLUMNS_NONE = 0 - no detection is performed, if different rows contain different number of values, then different number of TUs will be sent for different rows DETECT_COLUMNS_COL_NAMES = 1 - number of columns is determined by the number of field names listed in the row specified by the fieldNamesRow parameter. DETECT_COLUMNS_FIXED_NUMBER = 2 - number of columns is explicitly specified by the numColumns parameter.

Default: DETECT_COLUMNS_NONE

numColumns

public int numColumns

Number of columns in the input. This option is active only if detectColumnsMode = DETECT_COLUMNS_FIXED_NUMBER.

Extra columns are dropped, empty TUs are created for missing columns.

Default: 1

sendHeaderMode

public int sendHeaderMode

If there are one or more lines containing description of the data, names of fields etc., and actual data don't start in the first line, then such first lines are considered a header, and this option specifies how to handle them:

SEND_HEADER_NONE = 0 - none of the header lines are sent as text units SEND_HEADER_FIELD_NAMES_ONLY = 1 - only the values in the line specified by fieldNamesLineNum are sent as text units SEND_HEADER_ALL = 2 - values in all header lines are sent as text units