TextConnectorParams (Toolsverse API Reference 5.9)

Object
- com.toolsverse.etl.connector.DataSetConnectorParams
- - com.toolsverse.etl.connector.FileConnectorParams
  - - com.toolsverse.etl.connector.text.TextConnectorParams

All Implemented Interfaces:

Serializable
```
public class TextConnectorParams
extends FileConnectorParams
```
The DataSetConnectorParams used by TextConnector.

Since:

2.0

Version:

2.0

See Also:

TextConnector, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALWAYS_QUOTE_PROP` ALWAYS QUOTE property.
`static String`	`DATA_COLS_SAME_AS_FIELDS_PROP` The DATA_COLS_SAME_AS_FIELDS property.
`static String`	`DELIMETER_PROP` The DELIMETER property.
`static String`	`END_ROW_PROP` The END ROW property.
`static String`	`ESCAPE_QUOTE_PROP` ESCAPE QUOTE property.
`static String`	`EXTENSION_PROP` The EXTENSION property.
`static String`	`FIELDS_PROP` The FIELDS property.
`static String`	`FILTER_TRANSFORMATION` The Constant FILTER_TRANSFORMATION.
`static String`	`FIRST_ROW_DATA_PROP` The FIRST ROW HAS DATA property.
`static String`	`HAS_EXTRA_DATA_COLS_PROP` File has extra data columns *.
`static String`	`HEADER_TRANSFORMATION` The Constant HEADER_TRANSFORMATION.
`static String`	`IGNORE_BOM_PROP` IGNORE_BOM property.
`static String`	`LINESEPARATOR_PROP` The LINE SEPARATOR property.
`static String`	`MAX_ROWS_IN_FILE_PROP` MAX NUMBER OF ROWS IN THE FILE property.
`static String`	`METADATA_PROP` The METADATA property.
`static String`	`MULTI_LINE_RECORD_PROP` MULTI LINE RECORD property.
`static String`	`NONAME_COLUMN_NAME_PROP` The NONAME_COLUMN_NAME property.
`static String`	`PREFIX` The PREFIX.
`static String`	`PREPROCESSOR_TRANSFORMATION` The Constant PREPROCESSOR_TRANSFORMATION.
`static String`	`REMOVE_EOL_PROP` REMOVE EOL CHARACTER WHEN CREATING FILE property.
`static String`	`REORDER_PROP` REORDER property.
`static String`	`SKIP_BAD_PROP` SKIP "BAD" ROW WHEN READING DATA property.
`static String`	`SKIP_DATASET_COLUMN_PROP` IGNORE FIEDLS WITH DATASETS property.
`static String`	`SKIP_DATASET_ROW_PROP` IGNORE ROWS WITH DATASETS property.
`static String`	`SKIP_EMPTY_PROP` SKIP EMPTY ROWS WHEN READING DATA property.
`static String`	`SKIP_FEWER_PROP` SKIP ROW WITH FEWER COLUMNS WHEN READING DATA property.
`static String`	`SKIP_FIRST_PROP` SKIP FIRST ROW WHEN READING DATA property.
`static String`	`SKIP_MORE_PROP` SKIP ROW WITH MORE COLUMNS WHEN READING DATA property.
`static String`	`START_ROW_PROP` The START ROW property.
`static String`	`STRIP_NOT_PRINTABLE_PROP` STRIP NOT PRINTABLE property.
`static String`	`SYSTEM_LINE_SEPARATOR` The Constant SYSTEM_LINE_SEPARATOR.
`static String`	`TEXT_ENCODING_PROP` The TEXT encoding property.
`static String`	`TRANSFORMATION_TYPE_PROP` Type of the transformation (filter or preprocessor) property.
`static String`	`UNIX_LINE_SEPARATOR` The Constant UNIX_LINE_SEPARATOR.
`static String`	`VALUE_FOR_NULL_PROP` The VALUE_FOR_NULL property.
`static String`	`WINDOWS_LINE_SEPARATOR` The Constant WINDOWS_LINE_SEPARATOR.

Fields inherited from class com.toolsverse.etl.connector.FileConnectorParams
ADJUST_DATA_TYPE_PROP, ALL_STRINGS_PROP, BASE64_ENCODE_CLOB_PROP, BOOLEAN_AS_NUMBER_PROP, CONVERT_NULL_PROP, ENCODING_PROP, NAME_TO_SQL_NAME_PROP, NULL_IF_EMPTY_PROP, OVERRIDE_WILCARD_PROP, SPLIT_BY_PROP, SUFFIX_PROP, TEMPALTE_PROP

Fields inherited from class com.toolsverse.etl.connector.DataSetConnectorParams
AUTO_COMMIT_PROP, FILE_NAME_PROP, MAX_ROWS_EXCEEDED_EXCEPTION, PASSWORD_PROP, PROPERTIES_PROP, TRANSPORT_PROP, USE_SELECTED_PROP, USER_ID_PROP

Constructor Summary

Constructors
Constructor and Description
`TextConnectorParams()` Instantiates a new TextConnectorParams.
`TextConnectorParams(CacheProvider<String,Object> cacheProvider, boolean silent, int logStep)` Instantiates a new TextConnectorParams.
`TextConnectorParams(CacheProvider<String,Object> cacheProvider, boolean silent, int logStep, String delimiter, boolean persistMetaData)` Instantiates a new TextConnectorParams.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DataSetConnectorParams`	`copy()` Create a copy of this object.
`AtomicInteger`	`getBatchNumber()` Gets the batch number.
`String`	`getCharSeparator()` Gets the char separator.
`AtomicInteger`	`getCurrentBatchRow()` Gets the current batch row.
`String`	`getDelimiter()` Gets the delimiter.
`int`	`getEndRow()` Gets the end row.
`String`	`getExt()` Gets the file extension.
`String`	`getFields()` Gets the comma delimited string of field names.
`String`	`getFilter()` Gets the javascript filter.
`int[]`	`getLengthArray()` Gets the length array.
`String`	`getLineSeparator()` Gets the line separator.
`int`	`getMaxRowsInFile()` Gets the max number of rows in file created.
`String`	`getNonameColumnName()` Gets the noname column name.
`int`	`getNumberOfColumnsInFile()`
`String`	`getPropsHint()` Gets the hint displayed next to the properties editor.
`String`	`getPropsWizardResource(Driver driver, String connectionDriver)` Gets the name of the xml file used to create a wizard for editing properties.
`Character`	`getQuotePrefix()` Gets the quote prefix.
`String`	`getRealDelimiter()` Gets the real delimiter.
`int`	`getStartRow()` Gets the start row.
`String`	`getTitleRow()` Gets the title row.
`String`	`getTransformationType()` Gets the transformation type.
`String`	`getValueForNull()` Gets the value for null.
`Writer`	`getWriter()` Gets the writer.
`boolean`	`hasExtraDataCols()` Checks if file has extra data columns.
`void`	`init(Alias alis)` Initializes itself using given alias.
`void`	`init(Map<String,String> props)` Initializes itself using given properties.
`void`	`init(ObjectStorage storage)` Initializes itself using given object storage.
`boolean`	`isAlwaysQuote()` Checks if the property always quote is set.
`boolean`	`isEscapeQuote()` It true escape quotes in CSV.
`boolean`	`isFirstRowData()` Checks if "first row has data" flag was set.
`boolean`	`isIgnoreBom()` Checks if parser should ignore byte order mark (bom).
`boolean`	`isMultiLineRecord()` Checks if "potentially multi line record" flag is set.
`boolean`	`isNumberOfDataColsSameAsFields()` Checks if the number of data columns is the same as fields.
`boolean`	`isPersistMetaData()` Checks if "is persist meta data" flag was set.
`boolean`	`isRemoveEol()` Check if connector needs to remove the EOL characters when creating the file.
`boolean`	`isReorder()` Checks if columns should reordered suing order of vars before creating the files.
`boolean`	`isSkipBad()` Checks if skip bad (not properly formatted) rows flag is enabled.
`boolean`	`isSkipDataSetField()` Checks if "skip column with datasets when writing data" flag was set.
`boolean`	`isSkipDataSetRow()` Checks if "skip rows with dataset column when writing data" flag was set.
`boolean`	`isSkipEmpty()` Checks if "skip empty rows when reading data" flag was set.
`boolean`	`isSkipFirst()` Checks if skip first row flag is enabled.
`boolean`	`isSkipWhenFewerColumns()` Checks if is skip when fewer columns.
`boolean`	`isSkipWhenMoreColumns()` Checks if is skip when more columns.
`boolean`	`isStripNotPrintable()` Checks if system should strip not printable chars when writing.
`void`	`setAlwaysQuote(boolean alwaysQuote)` Sets the always quote property.
`void`	`setCharSeparator(String value)` Sets the char separator.
`void`	`setCleanUpPersistOccurred(boolean value)` Sets the flag "clean up has occurred".
`void`	`setDelimiter(String value)` Sets the delimiter.
`void`	`setEndRow(int endRow)` Sets the end row.
`void`	`setEscapeQuote(boolean escapeQuote)` Sets the escape quote.
`void`	`setExt(String value)` Sets the file extension.
`void`	`setFields(String value)` Sets the fields.
`void`	`setFilter(String filter)` Sets the javascript filter.
`void`	`setFirstRowData(boolean value)` Sets the "first row hash data" flag.
`void`	`setHasExtraDataCols(boolean hasExtraDataCols)` Sets the value of the flag "file has extra data columns".
`void`	`setIgnoreBom(boolean ignoreBom)` Sets the ignore byte order mark (bom) property.
`void`	`setLengthArray(int[] value)` Sets the length array.
`void`	`setLineSeparator(String value)` Sets the line separator.
`void`	`setMaxRowsInFile(int maxRowsInFile)` Sets the max number of rows in file created.
`void`	`setMultiLineRecord(boolean multiLineRecord)` Sets the flag which controls if multi line recorrds exist in the document.
`void`	`setNonameColumnName(String nonameColumnName)` Sets the noname column name.
`void`	`setNumberOfColumnsInFile(int numberOfColumnsInFile)`
`void`	`setNumberOfDataColsSameAsFields(boolean numberOfDataColsSameAsFields)` Sets the value of the "number of data columns same as fields" flag.
`void`	`setPersistMetaData(boolean value)` Sets the "persist meta data" flag.
`void`	`setQuotePrefix(Character quotePrefix)` Sets the quote prefix.
`void`	`setRemoveEol(boolean removeEol)` Sets the "remove eol" property.
`void`	`setReorder(boolean reorder)` Sets the new value of the reorder flag.
`void`	`setSkipBad(boolean skipBad)` Sets the skip bad rows flag.
`void`	`setSkipDataSetField(boolean value)` Sets the "skip dataset column when writing data" flag.
`void`	`setSkipDataSetRow(boolean value)` Sets the "skip dataset row when writing data" flag.
`void`	`setSkipEmpty(boolean value)` Sets the "skip empty rows when reading data" flag.
`void`	`setSkipFirst(boolean skipFirst)` Sets the skip first row flag.
`void`	`setSkipWhenFewerColumns(boolean skipWhenFewerColumns)` Sets the skip when fewer columns.
`void`	`setSkipWhenMoreColumns(boolean skipWhenMoreColumns)` Sets the skip when more columns.
`void`	`setStartRow(int startRow)` Sets the start row.
`void`	`setStripNotPrintable(boolean stripNotPrintable)` Sets the strip not printable flag.
`void`	`setTitleRow(String titleRow)` Sets the title row.
`void`	`setTransformationType(String transformationType)` Sets the transformation type.
`void`	`setValueForNull(String valueForNull)` Sets the value for null.
`void`	`setWriter(Writer value)` Sets the writer.

Methods inherited from class com.toolsverse.etl.connector.FileConnectorParams
alias2alias, deserializeToInputStream, getAlias, getCdata, getDateFormat, getDateTimeFormat, getEncoding, getFileName, getFileName, getFileNameIfFileSystem, getFolder, getInitStr, getOriginalAlias, getPassword, getProperties, getRealFileName, getSplitBy, getSuffix, getTemplate, getTemplateToUse, getTimeFormat, getTransport, getUserId, getWildcardUrl, isAdjustDataTypes, isAllStrings, isBooleanAsNumber, isConvertNameToSqlName, isConvertNull, isCurrentStreaming, isDateFormat, isDateTimeFormat, isDisableStreaming, isEncodeClob, isFileNameRequired, isForceExt, isNoOriginalFileName, isNullIfEmpty, isOverrideWildcrad, isParseDates, isTimeFormat, isTrimValue, needToEncode, selfDiscover, setAdjustDataTypes, setAllStrings, setBooleanAsNumber, setCdata, setConvertNameToSqlName, setConvertNull, setDateFormat, setDateTimeFormat, setDisableStreaming, setEncodeClob, setEncoding, setFieldDataType, setFileName, setFileNameRequired, setFolder, setForceExt, setNoOriginalFileName, setNullIfEmpty, setOverrideWildcrad, setParseDates, setPassword, setProperties, setRealFileName, setSplitBy, setSuffix, setTemplate, setTimeFormat, setTransport, setTrimValue, setUserId

Methods inherited from class com.toolsverse.etl.connector.DataSetConnectorParams
getAddFieldValueCallback, getAddRecordCallback, getAfterCallback, getBeforeCallback, getCacheProvider, getCrudAction, getInputStream, getIoProcessor, getLogStep, getMaxRows, getOutputStream, getParams, getReadTracker, getTarget, getTransactionMonitor, hasAddRecordCallback, isCleanUpPersistOccured, isCloseInput, isCloseOutput, isEnabled, isIgnoreEmpty, isIgnoreNoRecords, isMaxRowsExceededException, isPostPersistOccured, isPrePersistOccured, isReadOnlyMetadata, isSilent, isStreaming, prepareForPopulate, setAddFieldValueCallback, setAddRecordCallback, setAfterCallback, setBeforeCallback, setCacheProvider, setCloseInput, setCloseOutput, setCrudAction, setEnabled, setHasAddRecordCallback, setIgnoreEmpty, setIgnoreNoRecords, setInputStream, setIoProcessor, setLogStep, setMaxRows, setOutputStream, setPostPersistOccured, setPrePersistOccured, setReadOnlyMetadata, setReadTracker, setSilent, setTarget, setTransactionMonitor, setUseSelectedDataSet, useSelectedDataSet

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TEXT_ENCODING_PROP
```
public static final String TEXT_ENCODING_PROP
```
    The TEXT encoding property.
    
    See Also:
    
    Constant Field Values
  - UNIX_LINE_SEPARATOR
```
public static final String UNIX_LINE_SEPARATOR
```
    The Constant UNIX_LINE_SEPARATOR.
    
    See Also:
    
    Constant Field Values
  - WINDOWS_LINE_SEPARATOR
```
public static final String WINDOWS_LINE_SEPARATOR
```
    The Constant WINDOWS_LINE_SEPARATOR.
    
    See Also:
    
    Constant Field Values
  - SYSTEM_LINE_SEPARATOR
```
public static final String SYSTEM_LINE_SEPARATOR
```
    The Constant SYSTEM_LINE_SEPARATOR.
    
    See Also:
    
    Constant Field Values
  - PREFIX
```
public static final String PREFIX
```
    The PREFIX.
    
    See Also:
    
    Constant Field Values
  - LINESEPARATOR_PROP
```
public static final String LINESEPARATOR_PROP
```
    The LINE SEPARATOR property.
    
    See Also:
    
    Constant Field Values
  - DELIMETER_PROP
```
public static final String DELIMETER_PROP
```
    The DELIMETER property.
    
    See Also:
    
    Constant Field Values
  - FIELDS_PROP
```
public static final String FIELDS_PROP
```
    The FIELDS property.
    
    See Also:
    
    Constant Field Values
  - METADATA_PROP
```
public static final String METADATA_PROP
```
    The METADATA property.
    
    See Also:
    
    Constant Field Values
  - FIRST_ROW_DATA_PROP
```
public static final String FIRST_ROW_DATA_PROP
```
    The FIRST ROW HAS DATA property.
    
    See Also:
    
    Constant Field Values
  - SKIP_EMPTY_PROP
```
public static final String SKIP_EMPTY_PROP
```
    SKIP EMPTY ROWS WHEN READING DATA property.
    
    See Also:
    
    Constant Field Values
  - ALWAYS_QUOTE_PROP
```
public static final String ALWAYS_QUOTE_PROP
```
    ALWAYS QUOTE property.
    
    See Also:
    
    Constant Field Values
  - ESCAPE_QUOTE_PROP
```
public static final String ESCAPE_QUOTE_PROP
```
    ESCAPE QUOTE property.
    
    See Also:
    
    Constant Field Values
  - SKIP_FIRST_PROP
```
public static final String SKIP_FIRST_PROP
```
    SKIP FIRST ROW WHEN READING DATA property.
    
    See Also:
    
    Constant Field Values
  - SKIP_BAD_PROP
```
public static final String SKIP_BAD_PROP
```
    SKIP "BAD" ROW WHEN READING DATA property.
    
    See Also:
    
    Constant Field Values
  - SKIP_FEWER_PROP
```
public static final String SKIP_FEWER_PROP
```
    SKIP ROW WITH FEWER COLUMNS WHEN READING DATA property.
    
    See Also:
    
    Constant Field Values
  - SKIP_MORE_PROP
```
public static final String SKIP_MORE_PROP
```
    SKIP ROW WITH MORE COLUMNS WHEN READING DATA property.
    
    See Also:
    
    Constant Field Values
  - HAS_EXTRA_DATA_COLS_PROP
```
public static final String HAS_EXTRA_DATA_COLS_PROP
```
    File has extra data columns *.
    
    See Also:
    
    Constant Field Values
  - DATA_COLS_SAME_AS_FIELDS_PROP
```
public static final String DATA_COLS_SAME_AS_FIELDS_PROP
```
    The DATA_COLS_SAME_AS_FIELDS property.
    
    See Also:
    
    Constant Field Values
  - SKIP_DATASET_ROW_PROP
```
public static final String SKIP_DATASET_ROW_PROP
```
    IGNORE ROWS WITH DATASETS property.
    
    See Also:
    
    Constant Field Values
  - SKIP_DATASET_COLUMN_PROP
```
public static final String SKIP_DATASET_COLUMN_PROP
```
    IGNORE FIEDLS WITH DATASETS property.
    
    See Also:
    
    Constant Field Values
  - MAX_ROWS_IN_FILE_PROP
```
public static final String MAX_ROWS_IN_FILE_PROP
```
    MAX NUMBER OF ROWS IN THE FILE property.
    
    See Also:
    
    Constant Field Values
  - TRANSFORMATION_TYPE_PROP
```
public static final String TRANSFORMATION_TYPE_PROP
```
    Type of the transformation (filter or preprocessor) property.
    
    See Also:
    
    Constant Field Values
  - START_ROW_PROP
```
public static final String START_ROW_PROP
```
    The START ROW property.
    
    See Also:
    
    Constant Field Values
  - END_ROW_PROP
```
public static final String END_ROW_PROP
```
    The END ROW property.
    
    See Also:
    
    Constant Field Values
  - NONAME_COLUMN_NAME_PROP
```
public static final String NONAME_COLUMN_NAME_PROP
```
    The NONAME_COLUMN_NAME property.
    
    See Also:
    
    Constant Field Values
  - MULTI_LINE_RECORD_PROP
```
public static final String MULTI_LINE_RECORD_PROP
```
    MULTI LINE RECORD property.
    
    See Also:
    
    Constant Field Values
  - IGNORE_BOM_PROP
```
public static final String IGNORE_BOM_PROP
```
    IGNORE_BOM property.
    
    See Also:
    
    Constant Field Values
  - STRIP_NOT_PRINTABLE_PROP
```
public static final String STRIP_NOT_PRINTABLE_PROP
```
    STRIP NOT PRINTABLE property.
    
    See Also:
    
    Constant Field Values
  - VALUE_FOR_NULL_PROP
```
public static final String VALUE_FOR_NULL_PROP
```
    The VALUE_FOR_NULL property.
    
    See Also:
    
    Constant Field Values
  - EXTENSION_PROP
```
public static final String EXTENSION_PROP
```
    The EXTENSION property.
    
    See Also:
    
    Constant Field Values
  - REMOVE_EOL_PROP
```
public static final String REMOVE_EOL_PROP
```
    REMOVE EOL CHARACTER WHEN CREATING FILE property.
    
    See Also:
    
    Constant Field Values
  - REORDER_PROP
```
public static final String REORDER_PROP
```
    REORDER property.
    
    See Also:
    
    Constant Field Values
  - FILTER_TRANSFORMATION
```
public static final String FILTER_TRANSFORMATION
```
    The Constant FILTER_TRANSFORMATION.
    
    See Also:
    
    Constant Field Values
  - PREPROCESSOR_TRANSFORMATION
```
public static final String PREPROCESSOR_TRANSFORMATION
```
    The Constant PREPROCESSOR_TRANSFORMATION.
    
    See Also:
    
    Constant Field Values
  - HEADER_TRANSFORMATION
```
public static final String HEADER_TRANSFORMATION
```
    The Constant HEADER_TRANSFORMATION.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TextConnectorParams
```
public TextConnectorParams()
```
    Instantiates a new TextConnectorParams.
  - TextConnectorParams
```
public TextConnectorParams(CacheProvider<String,Object> cacheProvider,
                           boolean silent,
                           int logStep)
```
    Instantiates a new TextConnectorParams.
    
    Parameters:
    
    cacheProvider - the cache provider
    
    silent - the "is silent" flag
    
    logStep - the log step
  - TextConnectorParams
```
public TextConnectorParams(CacheProvider<String,Object> cacheProvider,
                           boolean silent,
                           int logStep,
                           String delimiter,
                           boolean persistMetaData)
```
    Instantiates a new TextConnectorParams.
    
    Parameters:
    
    cacheProvider - the cache provider
    
    silent - the "is silent" flag
    
    logStep - the log step
    
    delimiter - the delimiter
    
    persistMetaData - the "persist meta data" flag
- Method Detail
  - copy
```
public DataSetConnectorParams copy()
```
    Description copied from class: DataSetConnectorParams
    
    Create a copy of this object.
    
    Specified by:
    
    copy in class DataSetConnectorParams
    
    Returns:
    
    the copy of this object
  - getBatchNumber
```
public AtomicInteger getBatchNumber()
```
    Gets the batch number.
    
    Returns:
    
    the batchNumber
  - getCharSeparator
```
public String getCharSeparator()
```
    Gets the char separator.
    
    Returns:
    
    the char separator
  - getCurrentBatchRow
```
public AtomicInteger getCurrentBatchRow()
```
    Gets the current batch row.
    
    Returns:
    
    the currentBatchRow
  - getDelimiter
```
public String getDelimiter()
```
    Gets the delimiter.
    
    Returns:
    
    the delimiter
  - getExt
```
public String getExt()
```
    Gets the file extension. Default is ".dat".
    
    Returns:
    
    the file extension
  - getFields
```
public String getFields()
```
    Gets the comma delimited string of field names.
    
    Returns:
    
    the fields
  - getLengthArray
```
public int[] getLengthArray()
```
    Gets the length array.
    
    Returns:
    
    the length array
  - getLineSeparator
```
public String getLineSeparator()
```
    Gets the line separator.
    
    Returns:
    
    the line separator
  - getMaxRowsInFile
```
public int getMaxRowsInFile()
```
    Gets the max number of rows in file created.
    
    Returns:
    
    the int
  - getPropsHint
```
public String getPropsHint()
```
    Description copied from class: DataSetConnectorParams
    
    Gets the hint displayed next to the properties editor.
    
    Specified by:
    
    getPropsHint in class DataSetConnectorParams
    
    Returns:
    
    the hint
  - getPropsWizardResource
```
public String getPropsWizardResource(Driver driver,
                                     String connectionDriver)
```
    Description copied from class: DataSetConnectorParams
    
    Gets the name of the xml file used to create a wizard for editing properties.
    
    Specified by:
    
    getPropsWizardResource in class DataSetConnectorParams
    
    Parameters:
    
    driver - the ETL driver
    
    connectionDriver - the connection driver
    
    Returns:
    
    the name of the xml file
  - getQuotePrefix
```
public Character getQuotePrefix()
```
    Gets the quote prefix.
    
    Returns:
    
    the quotePrefix
  - getRealDelimiter
```
public String getRealDelimiter()
```
    Gets the real delimiter. Translates macros such as tab, amp to the real delimiters.
    
    Returns:
    
    the real delimiter
  - getTitleRow
```
public String getTitleRow()
```
    Gets the title row.
    
    Returns:
    
    the titleRow
  - getWriter
```
public Writer getWriter()
```
    Gets the writer.
    
    Returns:
    
    the writer
  - init
```
public void init(Alias alis)
```
    Description copied from class: DataSetConnectorParams
    
    Initializes itself using given alias.
    
    Overrides:
    
    init in class FileConnectorParams
    
    Parameters:
    
    alis - the alias
  - init
```
public void init(Map<String,String> props)
```
    Description copied from class: DataSetConnectorParams
    
    Initializes itself using given properties.
    
    Overrides:
    
    init in class FileConnectorParams
    
    Parameters:
    
    props - the properties
  - init
```
public void init(ObjectStorage storage)
```
    Description copied from class: DataSetConnectorParams
    
    Initializes itself using given object storage.
    
    Specified by:
    
    init in class DataSetConnectorParams
    
    Parameters:
    
    storage - the object storage
  - isFirstRowData
```
public boolean isFirstRowData()
```
    Checks if "first row has data" flag was set.
    
    Returns:
    
    true, if "first row has data" flag was set
  - isPersistMetaData
```
public boolean isPersistMetaData()
```
    Checks if "is persist meta data" flag was set.
    
    Returns:
    
    true, "is persist meta data" flag was set
  - isSkipDataSetField
```
public boolean isSkipDataSetField()
```
    Checks if "skip column with datasets when writing data" flag was set.
    
    Returns:
    
    true, if "skip column with datasets when writing data" flag was set
  - isSkipDataSetRow
```
public boolean isSkipDataSetRow()
```
    Checks if "skip rows with dataset column when writing data" flag was set.
    
    Returns:
    
    true, if "skip rows with dataset column when writing data" flag was set
  - isSkipEmpty
```
public boolean isSkipEmpty()
```
    Checks if "skip empty rows when reading data" flag was set.
    
    Returns:
    
    true, if "skip empty rows when reading data" flag was set
  - setCharSeparator
```
public void setCharSeparator(String value)
```
    Sets the char separator.
    
    Parameters:
    
    value - the new char separator
  - setCleanUpPersistOccurred
```
public void setCleanUpPersistOccurred(boolean value)
```
    Description copied from class: DataSetConnectorParams
    
    Sets the flag "clean up has occurred".
    
    Overrides:
    
    setCleanUpPersistOccurred in class DataSetConnectorParams
    
    Parameters:
    
    value - the new value for the flag "clean up has occurred"
  - setDelimiter
```
public void setDelimiter(String value)
```
    Sets the delimiter.
    
    Parameters:
    
    value - the new delimiter
  - setExt
```
public void setExt(String value)
```
    Sets the file extension.
    
    Parameters:
    
    value - the new file extension
  - setFields
```
public void setFields(String value)
```
    Sets the fields.
    
    Parameters:
    
    value - the new fields
  - setFirstRowData
```
public void setFirstRowData(boolean value)
```
    Sets the "first row hash data" flag.
    
    Parameters:
    
    value - the new value for the "first row has data" flag
  - setLengthArray
```
public void setLengthArray(int[] value)
```
    Sets the length array.
    
    Parameters:
    
    value - the new length array
  - setLineSeparator
```
public void setLineSeparator(String value)
```
    Sets the line separator.
    
    Parameters:
    
    value - the new line separator
  - setMaxRowsInFile
```
public void setMaxRowsInFile(int maxRowsInFile)
```
    Sets the max number of rows in file created.
    
    Parameters:
    
    maxRowsInFile - the maxRowsInFile to set
  - setPersistMetaData
```
public void setPersistMetaData(boolean value)
```
    Sets the "persist meta data" flag.
    
    Parameters:
    
    value - the new value for the "persist meta data" flag
  - setQuotePrefix
```
public void setQuotePrefix(Character quotePrefix)
```
    Sets the quote prefix.
    
    Parameters:
    
    quotePrefix - the quotePrefix to set
  - setSkipDataSetField
```
public void setSkipDataSetField(boolean value)
```
    Sets the "skip dataset column when writing data" flag.
    
    Parameters:
    
    value - the new value for the "skip dataset column when writing data" flag
  - setSkipDataSetRow
```
public void setSkipDataSetRow(boolean value)
```
    Sets the "skip dataset row when writing data" flag.
    
    Parameters:
    
    value - the new value for the "skip dataset row when writing data" flag
  - setSkipEmpty
```
public void setSkipEmpty(boolean value)
```
    Sets the "skip empty rows when reading data" flag.
    
    Parameters:
    
    value - the new value for the "skip empty rows when reading data" flag
  - setTitleRow
```
public void setTitleRow(String titleRow)
```
    Sets the title row.
    
    Parameters:
    
    titleRow - the titleRow to set
  - setWriter
```
public void setWriter(Writer value)
```
    Sets the writer.
    
    Parameters:
    
    value - the new writer
  - isSkipFirst
```
public boolean isSkipFirst()
```
    Checks if skip first row flag is enabled.
    
    Returns:
    
    true, if is skip first row flag is enabled
  - setSkipFirst
```
public void setSkipFirst(boolean skipFirst)
```
    Sets the skip first row flag.
    
    Parameters:
    
    skipFirst - boolean the new value of the skip first row flag
  - isSkipBad
```
public boolean isSkipBad()
```
    Checks if skip bad (not properly formatted) rows flag is enabled.
    
    Returns:
    
    true, if is skip bad row flag is enabled
  - setSkipBad
```
public void setSkipBad(boolean skipBad)
```
    Sets the skip bad rows flag.
    
    Parameters:
    
    skipBad - boolean the new value of the skip bad rows flag
  - getFilter
```
public String getFilter()
```
    Gets the javascript filter.
    
    Returns:
    
    the string
  - setFilter
```
public void setFilter(String filter)
```
    Sets the javascript filter.
    
    Parameters:
    
    filter - the new filter
  - hasExtraDataCols
```
public boolean hasExtraDataCols()
```
    Checks if file has extra data columns.
    
    Returns:
    
    true, if file has extra data columns
  - setHasExtraDataCols
```
public void setHasExtraDataCols(boolean hasExtraDataCols)
```
    Sets the value of the flag "file has extra data columns".
    
    Parameters:
    
    hasExtraDataCols - boolean
  - getTransformationType
```
public String getTransformationType()
```
    Gets the transformation type.
    
    Returns:
    
    the transformation type
  - setTransformationType
```
public void setTransformationType(String transformationType)
```
    Sets the transformation type.
    
    Parameters:
    
    transformationType - the new transformation type
  - getStartRow
```
public int getStartRow()
```
    Gets the start row.
    
    Returns:
    
    the start row
  - setStartRow
```
public void setStartRow(int startRow)
```
    Sets the start row.
    
    Parameters:
    
    startRow - the new start row
  - getEndRow
```
public int getEndRow()
```
    Gets the end row.
    
    Returns:
    
    the end row
  - setEndRow
```
public void setEndRow(int endRow)
```
    Sets the end row.
    
    Parameters:
    
    endRow - the new end row
  - getNonameColumnName
```
public String getNonameColumnName()
```
    Gets the noname column name.
    
    Returns:
    
    the noname column name
  - setNonameColumnName
```
public void setNonameColumnName(String nonameColumnName)
```
    Sets the noname column name.
    
    Parameters:
    
    nonameColumnName - the new noname column name
  - isMultiLineRecord
```
public boolean isMultiLineRecord()
```
    Checks if "potentially multi line record" flag is set.
    
    Returns:
    
    true, if " potentially multi line record" flag i set
  - setMultiLineRecord
```
public void setMultiLineRecord(boolean multiLineRecord)
```
    Sets the flag which controls if multi line recorrds exist in the document.
    
    Parameters:
    
    multiLineRecord - boolean
  - isNumberOfDataColsSameAsFields
```
public boolean isNumberOfDataColsSameAsFields()
```
    Checks if the number of data columns is the same as fields.
    
    Returns:
    
    true, if the number of data columns is the same as fields
  - setNumberOfDataColsSameAsFields
```
public void setNumberOfDataColsSameAsFields(boolean numberOfDataColsSameAsFields)
```
    Sets the value of the "number of data columns same as fields" flag.
    
    Parameters:
    
    numberOfDataColsSameAsFields - boolean
  - isIgnoreBom
```
public boolean isIgnoreBom()
```
    Checks if parser should ignore byte order mark (bom). The default is true.
    
    Returns:
    
    true, if parser should ignore byte order mark (bom)
  - setIgnoreBom
```
public void setIgnoreBom(boolean ignoreBom)
```
    Sets the ignore byte order mark (bom) property.
    
    Parameters:
    
    ignoreBom - the new value of the ignore bom property
  - isAlwaysQuote
```
public boolean isAlwaysQuote()
```
    Checks if the property always quote is set.
    
    Returns:
    
    true, if the property always quote is set
  - setAlwaysQuote
```
public void setAlwaysQuote(boolean alwaysQuote)
```
    Sets the always quote property.
    
    Parameters:
    
    alwaysQuote - the new value of the always quote property
  - isStripNotPrintable
```
public boolean isStripNotPrintable()
```
    Checks if system should strip not printable chars when writing.
    
    Returns:
    
    true, if system should strip not printable chars when writing
  - setStripNotPrintable
```
public void setStripNotPrintable(boolean stripNotPrintable)
```
    Sets the strip not printable flag.
    
    Parameters:
    
    stripNotPrintable - the new value of the strip not printable flag
  - getValueForNull
```
public String getValueForNull()
```
    Gets the value for null.
    
    Returns:
    
    the value for null
  - setValueForNull
```
public void setValueForNull(String valueForNull)
```
    Sets the value for null.
    
    Parameters:
    
    valueForNull - the new value for null
  - isEscapeQuote
```
public boolean isEscapeQuote()
```
    It true escape quotes in CSV.
    
    Returns:
    
    true, if escape quotes in CSV is set
  - setEscapeQuote
```
public void setEscapeQuote(boolean escapeQuote)
```
    Sets the escape quote.
    
    Parameters:
    
    escapeQuote - the new escape quote
  - isSkipWhenFewerColumns
```
public boolean isSkipWhenFewerColumns()
```
    Checks if is skip when fewer columns.
    
    Returns:
    
    true, if is skip when fewer columns
  - setSkipWhenFewerColumns
```
public void setSkipWhenFewerColumns(boolean skipWhenFewerColumns)
```
    Sets the skip when fewer columns.
    
    Parameters:
    
    skipWhenFewerColumns - the new skip when fewer columns
  - isSkipWhenMoreColumns
```
public boolean isSkipWhenMoreColumns()
```
    Checks if is skip when more columns.
    
    Returns:
    
    true, if is skip when more columns
  - setSkipWhenMoreColumns
```
public void setSkipWhenMoreColumns(boolean skipWhenMoreColumns)
```
    Sets the skip when more columns.
    
    Parameters:
    
    skipWhenMoreColumns - the new skip when more columns
  - getNumberOfColumnsInFile
```
public int getNumberOfColumnsInFile()
```
  - setNumberOfColumnsInFile
```
public void setNumberOfColumnsInFile(int numberOfColumnsInFile)
```
  - isRemoveEol
```
public boolean isRemoveEol()
```
    Check if connector needs to remove the EOL characters when creating the file.
    
    Returns:
    
    true, if onnector needs to remove the EOL characters when creating the file
  - setRemoveEol
```
public void setRemoveEol(boolean removeEol)
```
    Sets the "remove eol" property.
    
    Parameters:
    
    removeEol - boolean
  - isReorder
```
public boolean isReorder()
```
    Checks if columns should reordered suing order of vars before creating the files.
    
    Returns:
    
    true, if columns should reordered suing order of vars before creating the files
  - setReorder
```
public void setReorder(boolean reorder)
```
    Sets the new value of the reorder flag.
    
    Parameters:
    
    reorder - boolean

Class TextConnectorParams

Field Summary

Fields inherited from class com.toolsverse.etl.connector.FileConnectorParams

Fields inherited from class com.toolsverse.etl.connector.DataSetConnectorParams

Constructor Summary

Method Summary

Methods inherited from class com.toolsverse.etl.connector.FileConnectorParams

Methods inherited from class com.toolsverse.etl.connector.DataSetConnectorParams

Methods inherited from class Object

Field Detail

TEXT_ENCODING_PROP

UNIX_LINE_SEPARATOR

WINDOWS_LINE_SEPARATOR

SYSTEM_LINE_SEPARATOR

PREFIX

LINESEPARATOR_PROP

DELIMETER_PROP

FIELDS_PROP

METADATA_PROP

FIRST_ROW_DATA_PROP

SKIP_EMPTY_PROP

ALWAYS_QUOTE_PROP

ESCAPE_QUOTE_PROP

SKIP_FIRST_PROP

SKIP_BAD_PROP

SKIP_FEWER_PROP

SKIP_MORE_PROP

HAS_EXTRA_DATA_COLS_PROP

DATA_COLS_SAME_AS_FIELDS_PROP

SKIP_DATASET_ROW_PROP

SKIP_DATASET_COLUMN_PROP

MAX_ROWS_IN_FILE_PROP

TRANSFORMATION_TYPE_PROP

START_ROW_PROP

END_ROW_PROP

NONAME_COLUMN_NAME_PROP

MULTI_LINE_RECORD_PROP

IGNORE_BOM_PROP

STRIP_NOT_PRINTABLE_PROP

VALUE_FOR_NULL_PROP

EXTENSION_PROP

REMOVE_EOL_PROP

REORDER_PROP

FILTER_TRANSFORMATION

PREPROCESSOR_TRANSFORMATION

HEADER_TRANSFORMATION

Constructor Detail

TextConnectorParams

TextConnectorParams

TextConnectorParams

Method Detail

copy

getBatchNumber

getCharSeparator

getCurrentBatchRow

getDelimiter

getExt

getFields

getLengthArray

getLineSeparator

getMaxRowsInFile

getPropsHint

getPropsWizardResource

getQuotePrefix

getRealDelimiter

getTitleRow

getWriter

init

init

init

isFirstRowData

isPersistMetaData

isSkipDataSetField

isSkipDataSetRow

isSkipEmpty

setCharSeparator

setCleanUpPersistOccurred

setDelimiter

setExt

setFields