public class ExcelConnectorParams extends FileConnectorParams
DataSetConnectorParams
used by
ExcelConnector
.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.
|
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
AUTO_COMMIT_PROP, FILE_NAME_PROP, MAX_ROWS_EXCEEDED_EXCEPTION, PASSWORD_PROP, PROPERTIES_PROP, TRANSPORT_PROP, USE_SELECTED_PROP, USER_ID_PROP
Constructor and Description |
---|
ExcelConnectorParams()
Instantiates a new ExcelConnectorParams.
|
ExcelConnectorParams(CacheProvider<String,Object> cacheProvider,
boolean silent,
int logStep)
Instantiates a new ExcelConnectorParams.
|
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.
|
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
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
public static final String PREFIX
public static final String SHEET_NAME_PROP
public static final String START_ROW_PROP
public static final String END_ROW_PROP
public static final String START_GROUPING_ROW_PROP
public static final String END_GROUPING_ROW_PROP
public static final String ENCODE_PROP
public static final String SKIP_EMPTY_PROP
public static final String SHEET_ALREADY_EXTRACTED_EXCEPTION
public ExcelConnectorParams()
public ExcelConnectorParams(CacheProvider<String,Object> cacheProvider, boolean silent, int logStep)
cacheProvider
- the cache providersilent
- the "is silent" flaglogStep
- the log steppublic DataSetConnectorParams copy()
DataSetConnectorParams
copy
in class DataSetConnectorParams
public int getCurrentRow()
public org.apache.poi.ss.usermodel.CellStyle getDateCellStyle()
public org.apache.poi.ss.usermodel.CellStyle getDateTimeCellStyle()
public String getInitStr(String name, Alias alias)
DataSetConnectorParams
getInitStr
in class FileConnectorParams
name
- the namealias
- the aliaspublic OutputStream getOut()
public String getPropsHint()
DataSetConnectorParams
getPropsHint
in class DataSetConnectorParams
public String getPropsWizardResource(Driver driver, String connectionDriver)
DataSetConnectorParams
getPropsWizardResource
in class DataSetConnectorParams
driver
- the ETL driverconnectionDriver
- the connection driverpublic org.apache.poi.ss.usermodel.Sheet getSheet()
public String getSheetName()
public org.apache.poi.ss.usermodel.CellStyle getTimeCellStyle()
public org.apache.poi.ss.usermodel.Workbook getWorkbook()
public void init(Alias alis)
DataSetConnectorParams
init
in class FileConnectorParams
alis
- the aliaspublic void init(Map<String,String> props)
DataSetConnectorParams
init
in class FileConnectorParams
props
- the propertiespublic void init(ObjectStorage storage)
DataSetConnectorParams
init
in class DataSetConnectorParams
storage
- the object storagepublic boolean isEncodeInnerDataSets()
public boolean isSheetAlreadyExatractedException(Exception ex)
ex
- the exceptionpublic void prepareForPopulate()
DataSetConnectorParams
prepareForPopulate
in class DataSetConnectorParams
public void setCurrentRow(int value)
value
- the new current rowpublic void setDateCellStyle(org.apache.poi.ss.usermodel.CellStyle value)
value
- the new date cell stylepublic void setDateTimeCellStyle(org.apache.poi.ss.usermodel.CellStyle value)
value
- the new date time cell stylepublic void setEncodeInnerDataSets(boolean value)
value
- the new value for the flagpublic void setOut(OutputStream value)
value
- the new output streampublic void setSheet(org.apache.poi.ss.usermodel.Sheet value)
value
- the new sheetpublic void setSheetName(String value)
value
- the new sheet namepublic void setTimeCellStyle(org.apache.poi.ss.usermodel.CellStyle value)
value
- the new time cell stylepublic void setWorkbook(org.apache.poi.ss.usermodel.Workbook value)
value
- the new workbookpublic int getStartRow()
public void setStartRow(int startRow)
startRow
- the new start rowpublic int getEndRow()
public void setEndRow(int endRow)
endRow
- the new end rowpublic boolean isSkipEmpty()
public void setSkipEmpty(boolean skipEmpty)
skipEmpty
- the new value of the flag which controls if empty rows should
be ignored.public TypedKeyValue<String,String> getFileAndObjectName(String name)
name
- the original namepublic void updateFilenameAndSheetName(DataSet dataSet)
dataSet
- the data setpublic boolean isADateFormat(int fIndex, String formatString)
fIndex
- the f indexformatString
- the format stringpublic int getStartGroupingRow()
public void setStartGroupingRow(int startGroupingRow)
startGroupingRow
- the new start grouping rowpublic int getEndGroupingRow()
public void setEndGroupingRow(int endGroupingRow)
endGroupingRow
- the new end grouping rowCopyright © 2010-2020 Toolsverse. All Rights Reserved.