com.toolsverse.etl.connector.excel

Class ExcelConnectorParams

Object

com.toolsverse.etl.connector.DataSetConnectorParams

com.toolsverse.etl.connector.FileConnectorParams

com.toolsverse.etl.connector.excel.ExcelConnectorParams

All Implemented Interfaces:

Serializable

public class ExcelConnectorParams
extends FileConnectorParams

The DataSetConnectorParams used by ExcelConnector.

Since:

2.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENCODE_PROP The encode inner data sets property.
static String	END_GROUPING_ROW_PROP The END GROUPING ROW property.
static String	END_ROW_PROP The END ROW property.
static String	PREFIX The PREFIX.
static String	SHEET_ALREADY_EXTRACTED_EXCEPTION The SHEET ALREADY EXTRACTED EXCEPTION.
static String	SHEET_NAME_PROP The SHEET NAME property.
static String	SKIP_EMPTY_PROP SKIP EMPTY ROWS WHEN READING DATA property.
static String	START_GROUPING_ROW_PROP The START GROUPING ROW property.
static String	START_ROW_PROP The START ROW property.

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
ExcelConnectorParams() Instantiates a new ExcelConnectorParams.
ExcelConnectorParams(CacheProvider<String,Object> cacheProvider, boolean silent, int logStep) Instantiates a new ExcelConnectorParams.

Method Summary

Modifier and Type	Method and Description
DataSetConnectorParams	copy() Create a copy of this object.
int	getCurrentRow() Gets the current row index.
org.apache.poi.ss.usermodel.CellStyle	getDateCellStyle() Gets the date cell style.
org.apache.poi.ss.usermodel.CellStyle	getDateTimeCellStyle() Gets the date time cell style.
int	getEndGroupingRow() Gets the end grouping row.
int	getEndRow() Gets the end row.
TypedKeyValue<String,String>	getFileAndObjectName(String name) Gets the file and object name.
String	getInitStr(String name, Alias alias) Gets the initialization string using given alias.
OutputStream	getOut() Gets the output stream.
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.
org.apache.poi.ss.usermodel.Sheet	getSheet() Gets the current sheet.
String	getSheetName() Gets the current sheet name.
int	getStartGroupingRow() Gets the start grouping row.
int	getStartRow() Gets the start row.
org.apache.poi.ss.usermodel.CellStyle	getTimeCellStyle() Gets the time cell style.
org.apache.poi.ss.usermodel.Workbook	getWorkbook() Gets the workbook.
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	isADateFormat(int fIndex, String formatString) Checks if is a date format.
boolean	isEncodeInnerDataSets() Checks if inner data sets should be encoded using base64.
boolean	isSheetAlreadyExatractedException(Exception ex) Checks if given exception is a "sheet already extracted" exception.
boolean	isSkipEmpty() Checks if empty rows should be ignored.
void	prepareForPopulate() This is called from UI when connection parameters need to be prepared to be used by to pipulate a data set .
void	setCurrentRow(int value) Sets the current row.
void	setDateCellStyle(org.apache.poi.ss.usermodel.CellStyle value) Sets the date cell style.
void	setDateTimeCellStyle(org.apache.poi.ss.usermodel.CellStyle value) Sets the date time cell style.
void	setEncodeInnerDataSets(boolean value) Set to true if you want o encode inner data sets using base64.
void	setEndGroupingRow(int endGroupingRow) Sets the end grouping row.
void	setEndRow(int endRow) Sets the end row.
void	setOut(OutputStream value) Sets the output stream.
void	setSheet(org.apache.poi.ss.usermodel.Sheet value) Sets the sheet.
void	setSheetName(String value) Sets the sheet name.
void	setSkipEmpty(boolean skipEmpty) Sets the flag which controls if empty rows should be ignored.
void	setStartGroupingRow(int startGroupingRow) Sets the start grouping row.
void	setStartRow(int startRow) Sets the start row.
void	setTimeCellStyle(org.apache.poi.ss.usermodel.CellStyle value) Sets the time cell style.
void	setWorkbook(org.apache.poi.ss.usermodel.Workbook value) Sets the workbook.
void	updateFilenameAndSheetName(DataSet dataSet) Update filename and woksheet name.

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

alias2alias, deserializeToInputStream, getAlias, getCdata, getDateFormat, getDateTimeFormat, getEncoding, getFileName, getFileName, getFileNameIfFileSystem, getFolder, 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, setAddFieldValueCallback, setAddRecordCallback, setAfterCallback, setBeforeCallback, setCacheProvider, setCleanUpPersistOccurred, 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

PREFIX

public static final String PREFIX

The PREFIX.

See Also:

Constant Field Values

SHEET_NAME_PROP

public static final String SHEET_NAME_PROP

The SHEET NAME 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

START_GROUPING_ROW_PROP

public static final String START_GROUPING_ROW_PROP

The START GROUPING ROW property.

See Also:

Constant Field Values

END_GROUPING_ROW_PROP

public static final String END_GROUPING_ROW_PROP

The END GROUPING ROW property.

See Also:

Constant Field Values

ENCODE_PROP

public static final String ENCODE_PROP

The encode inner data sets 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

SHEET_ALREADY_EXTRACTED_EXCEPTION

public static final String SHEET_ALREADY_EXTRACTED_EXCEPTION

The SHEET ALREADY EXTRACTED EXCEPTION.

See Also:

Constant Field Values

Constructor Detail

ExcelConnectorParams

public ExcelConnectorParams()

Instantiates a new ExcelConnectorParams.

ExcelConnectorParams

public ExcelConnectorParams(CacheProvider<String,Object> cacheProvider,
                            boolean silent,
                            int logStep)

Instantiates a new ExcelConnectorParams.

Parameters:

cacheProvider - the cache provider

silent - the "is silent" flag

logStep - the log step

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

getCurrentRow

public int getCurrentRow()

Gets the current row index.

Returns:

the current row index

getDateCellStyle

public org.apache.poi.ss.usermodel.CellStyle getDateCellStyle()

Gets the date cell style.

Returns:

the date cell style

getDateTimeCellStyle

public org.apache.poi.ss.usermodel.CellStyle getDateTimeCellStyle()

Gets the date time cell style.

Returns:

the date time cell style

getInitStr

public String getInitStr(String name,
                         Alias alias)

Description copied from class: DataSetConnectorParams

Gets the initialization string using given alias. Used by ETL framework.

Overrides:

getInitStr in class FileConnectorParams

Parameters:

name - the name

alias - the alias

Returns:

the initialization string

getOut

public OutputStream getOut()

Gets the output stream.

Returns:

the output stream

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

getSheet

public org.apache.poi.ss.usermodel.Sheet getSheet()

Gets the current sheet.

Returns:

the current sheet

getSheetName

public String getSheetName()

Gets the current sheet name.

Returns:

the current sheet name

getTimeCellStyle

public org.apache.poi.ss.usermodel.CellStyle getTimeCellStyle()

Gets the time cell style.

Returns:

the time cell style

getWorkbook

public org.apache.poi.ss.usermodel.Workbook getWorkbook()

Gets the workbook.

Returns:

the workbook

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

isEncodeInnerDataSets

public boolean isEncodeInnerDataSets()

Checks if inner data sets should be encoded using base64.

Returns:

true, if inner data sets should be encoded

isSheetAlreadyExatractedException

public boolean isSheetAlreadyExatractedException(Exception ex)

Checks if given exception is a "sheet already extracted" exception.

Parameters:

ex - the exception

Returns:

true, if given exception is a "sheet already extracted" exception

prepareForPopulate

public void prepareForPopulate()

Description copied from class: DataSetConnectorParams

This is called from UI when connection parameters need to be prepared to be used by to pipulate a data set .

Overrides:

prepareForPopulate in class DataSetConnectorParams

setCurrentRow

public void setCurrentRow(int value)

Sets the current row.

Parameters:

value - the new current row

setDateCellStyle

public void setDateCellStyle(org.apache.poi.ss.usermodel.CellStyle value)

Sets the date cell style.

Parameters:

value - the new date cell style

setDateTimeCellStyle

public void setDateTimeCellStyle(org.apache.poi.ss.usermodel.CellStyle value)

Sets the date time cell style.

Parameters:

value - the new date time cell style

setEncodeInnerDataSets

public void setEncodeInnerDataSets(boolean value)

Set to true if you want o encode inner data sets using base64. The default value is false.

Parameters:

value - the new value for the flag

setOut

public void setOut(OutputStream value)

Sets the output stream.

Parameters:

value - the new output stream

setSheet

public void setSheet(org.apache.poi.ss.usermodel.Sheet value)

Sets the sheet.

Parameters:

value - the new sheet

setSheetName

public void setSheetName(String value)

Sets the sheet name.

Parameters:

value - the new sheet name

setTimeCellStyle

public void setTimeCellStyle(org.apache.poi.ss.usermodel.CellStyle value)

Sets the time cell style.

Parameters:

value - the new time cell style

setWorkbook

public void setWorkbook(org.apache.poi.ss.usermodel.Workbook value)

Sets the workbook.

Parameters:

value - the new workbook

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

isSkipEmpty

public boolean isSkipEmpty()

Checks if empty rows should be ignored.

Returns:

true, if empty rows should be ignored

setSkipEmpty

public void setSkipEmpty(boolean skipEmpty)

Sets the flag which controls if empty rows should be ignored.

Parameters:

skipEmpty - the new value of the flag which controls if empty rows should be ignored.

getFileAndObjectName

public TypedKeyValue<String,String> getFileAndObjectName(String name)

Gets the file and object name. This function is typically used to retrieve the filename and the worksheet name.

Parameters:

name - the original name

Returns:

the file name and the object name

updateFilenameAndSheetName

public void updateFilenameAndSheetName(DataSet dataSet)

Update filename and woksheet name.

Parameters:

dataSet - the data set

isADateFormat

public boolean isADateFormat(int fIndex,
                             String formatString)

Checks if is a date format.

Parameters:

fIndex - the f index

formatString - the format string

Returns:

true, if is a date format

getStartGroupingRow

public int getStartGroupingRow()

Gets the start grouping row.

Returns:

the start grouping row

setStartGroupingRow

public void setStartGroupingRow(int startGroupingRow)

Sets the start grouping row.

Parameters:

startGroupingRow - the new start grouping row

getEndGroupingRow

public int getEndGroupingRow()

Gets the end grouping row.

Returns:

the end grouping row

setEndGroupingRow

public void setEndGroupingRow(int endGroupingRow)

Sets the end grouping row.

Parameters:

endGroupingRow - the new end grouping row