com.toolsverse.etl.connector.xml

Class XmlConnectorParams

Object

com.toolsverse.etl.connector.DataSetConnectorParams

com.toolsverse.etl.connector.FileConnectorParams

com.toolsverse.etl.connector.xml.XmlConnectorParams

All Implemented Interfaces:

Serializable

public class XmlConnectorParams
extends FileConnectorParams

The DataSetConnectorParams used by XmlConnector.

Since:

2.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREFIX The PREFIX.
static String	XML_VERSION_PROP The xml version property.
static String	XSL_FILE_NAME_PROP The XSL FILE NAME property.
static String	XSL_FROM_FILE_NAME_PROP The XSL "FROM" FILE NAME property.
static String	XSL_TO_FILE_NAME_PROP The XSL "TO" FILE NAME 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
XmlConnectorParams() Instantiates a new XmlConnectorParams.
XmlConnectorParams(CacheProvider<String,Object> cacheProvider, boolean silent, int logStep) Instantiates a new XmlConnectorParams.

Method Summary

Modifier and Type	Method and Description
DataSetConnectorParams	copy() Create a copy of this object.
OutputStream	getFileOutputStream() Gets the file 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.
String	getTempFileName() Gets the temporary file name.
XMLStreamWriter	getWriter() Gets the writer.
String	getXmlVersion() Gets the xml version.
String	getXslFromFileName(String fileName) Gets the xsl "from" file name.
String	getXslToFileName(String fileName) Gets the xsl "to" file name.
void	init(Alias alais) 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	needToEncode() Checks if char values need to be encoded.
void	setFileOutputStream(OutputStream value) Sets the file output stream.
void	setTempFileName(String value) Sets the temporary file name.
void	setWriter(XMLStreamWriter writer) Sets the writer.
void	setXmlVersion(String xmlVersion) Sets the xml version.
void	setXslFileName(String value) Sets the xsl file name.
void	setXslFromFileName(String value) Sets the xsl "from" file name.
void	setXslToFileName(String value) Sets the xsl "to" file name.

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, 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, 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

XSL_FILE_NAME_PROP

public static final String XSL_FILE_NAME_PROP

The XSL FILE NAME property.

See Also:

Constant Field Values

XSL_FROM_FILE_NAME_PROP

public static final String XSL_FROM_FILE_NAME_PROP

The XSL "FROM" FILE NAME property.

See Also:

Constant Field Values

XSL_TO_FILE_NAME_PROP

public static final String XSL_TO_FILE_NAME_PROP

The XSL "TO" FILE NAME property.

See Also:

Constant Field Values

XML_VERSION_PROP

public static final String XML_VERSION_PROP

The xml version property.

See Also:

Constant Field Values

Constructor Detail

XmlConnectorParams

public XmlConnectorParams()

Instantiates a new XmlConnectorParams.

XmlConnectorParams

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

Instantiates a new XmlConnectorParams.

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

getFileOutputStream

public OutputStream getFileOutputStream()

Gets the file output stream.

Returns:

the file 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

getTempFileName

public String getTempFileName()

Gets the temporary file name.

Returns:

the temporary file name

getWriter

public XMLStreamWriter getWriter()

Gets the writer.

Returns:

the writer

getXslFromFileName

public String getXslFromFileName(String fileName)

Gets the xsl "from" file name.

Parameters:

fileName - the file name

Returns:

the xsl "from" file name

getXslToFileName

public String getXslToFileName(String fileName)

Gets the xsl "to" file name.

Parameters:

fileName - the file name

Returns:

the xsl "to" file name

init

public void init(Alias alais)

Description copied from class: DataSetConnectorParams

Initializes itself using given alias.

Overrides:

init in class FileConnectorParams

Parameters:

alais - 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

needToEncode

public boolean needToEncode()

Description copied from class: FileConnectorParams

Checks if char values need to be encoded.

Overrides:

needToEncode in class FileConnectorParams

Returns:

true, if char values need to be encoded

setFileOutputStream

public void setFileOutputStream(OutputStream value)

Sets the file output stream.

Parameters:

value - the new output stream

setTempFileName

public void setTempFileName(String value)

Sets the temporary file name.

Parameters:

value - the new temporary file name

setWriter

public void setWriter(XMLStreamWriter writer)

Sets the writer.

Parameters:

writer - the new writer

setXslFileName

public void setXslFileName(String value)

Sets the xsl file name.

Parameters:

value - the new xsl file name

setXslFromFileName

public void setXslFromFileName(String value)

Sets the xsl "from" file name.

Parameters:

value - the new xsl "from" file name

setXslToFileName

public void setXslToFileName(String value)

Sets the xsl "to" file name.

Parameters:

value - the new xsl "to" file name

getXmlVersion

public String getXmlVersion()

Gets the xml version.

Returns:

the xml version

setXmlVersion

public void setXmlVersion(String xmlVersion)

Sets the xml version.

Parameters:

xmlVersion - the new xml version