com.toolsverse.etl.connector.xml

Class XmlObjectConnector

Object

com.toolsverse.ext.BaseExtension

com.toolsverse.etl.connector.BaseDataSetConnector

com.toolsverse.etl.connector.xml.XmlObjectStreamingConnector

com.toolsverse.etl.connector.xml.XmlObjectConnector

All Implemented Interfaces:

DataSetConnector<XmlObjectConnectorParams,ConnectorResult>, ExtensionModule, StreamingConnector<XmlStreamingPackage,XmlProducerPackage>, Serializable, Comparable<ExtensionModule>

public class XmlObjectConnector
extends XmlObjectStreamingConnector

Reads and writes xml files. Does not support data streaming.

Since:

4.0

Version:

1.0

See Also:

Serialized Form

Field Summary

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

DEFAULT_IMPORT

Fields inherited from interface com.toolsverse.ext.ExtensionModule

APP, COMMAND, ETL_DRIVER, FORMATTER, IDE_NODE, NO_RANK, WIDGET

Constructor Summary

Constructors

Constructor and Description
XmlObjectConnector()

Method Summary

Modifier and Type	Method and Description
boolean	consume(XmlStreamingPackage streamingPackage, Object message, AtomicInteger row) Consume the next record.
String	getName() Gets the name.
String	getVersion() Gets the version of the extension module.
String	initQueryLabel() The init query label.
void	parseNode(XmlUtils xml, org.w3c.dom.Node node, XmlObjectConnectorParams params, Driver driver, Map<Integer,Boolean> types, DataSet dataSet, DataSetRecord record, XmlUtils.NodeType rootNodeType, DataSet newDataSet)
DataSetRecord	parseXml(XmlUtils xml, org.w3c.dom.Node root, XmlObjectConnectorParams params, Driver driver, Map<Integer,Boolean> types, DataSet dataSet, DataSetRecord record, XmlUtils.NodeType rootNodeType, org.w3c.dom.NodeList nodeList, XmlUtils.NodeType thisNodeType) Parses the xml and creates a hierarchy of the data sets.
ConnectorResult	populate(XmlObjectConnectorParams params, DataSet dataSet, Driver driver) Populates data set.
boolean	supportsNested() Supports nested.
boolean	supportsReadStreaming() Supports read streaming.
boolean	supportsWriteStreaming() Supports write streaming.

Methods inherited from class com.toolsverse.etl.connector.xml.XmlObjectStreamingConnector

beforeStream, canRead, canWrite, cleanUp, closeStream, endStream, getDataSetConnectorParams, getDisplayName, getExt, getVendor, getXmlConfigFileName, getXmlTagName, inlinePersist, isFileConnector, isTextFormat, persist, postPersist, prePersist, startStream, transform, writeMetaData

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

addValue, basePostPersist, getCommitPolicy, getInputStream, getIoProcessor, getLicensePropertyName, getReader, getType, postPersistWhenEmpty, setCommitPolicy, stream, supportsWorksheets, testConnection

Methods inherited from class com.toolsverse.ext.BaseExtension

compareTo, getConfigFileName, getExtensionRank, getIconPath, getLocalUnitClassPath

Methods inherited from class Object

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

Methods inherited from interface com.toolsverse.etl.connector.DataSetConnector

supportsReordering, supportsWorksheets, testConnection

Methods inherited from interface com.toolsverse.io.StreamingConnector

getCommitPolicy, setCommitPolicy

Constructor Detail

XmlObjectConnector

public XmlObjectConnector()

Method Detail

supportsReadStreaming

public boolean supportsReadStreaming()

Description copied from interface: DataSetConnector

Supports read streaming.

Specified by:

supportsReadStreaming in interface DataSetConnector<XmlObjectConnectorParams,ConnectorResult>

Overrides:

supportsReadStreaming in class XmlObjectStreamingConnector

Returns:

true, if successful

supportsWriteStreaming

public boolean supportsWriteStreaming()

Description copied from interface: DataSetConnector

Supports write streaming.

Specified by:

supportsWriteStreaming in interface DataSetConnector<XmlObjectConnectorParams,ConnectorResult>

Overrides:

supportsWriteStreaming in class XmlObjectStreamingConnector

Returns:

true, if successful

getName

public String getName()

Description copied from interface: DataSetConnector

Gets the name.

Specified by:

getName in interface DataSetConnector<XmlObjectConnectorParams,ConnectorResult>

Overrides:

getName in class XmlObjectStreamingConnector

Returns:

the name

getVersion

public String getVersion()

Description copied from interface: ExtensionModule

Gets the version of the extension module.

Specified by:

getVersion in interface ExtensionModule

Overrides:

getVersion in class XmlObjectStreamingConnector

Returns:

the version

parseNode

public void parseNode(XmlUtils xml,
                      org.w3c.dom.Node node,
                      XmlObjectConnectorParams params,
                      Driver driver,
                      Map<Integer,Boolean> types,
                      DataSet dataSet,
                      DataSetRecord record,
                      XmlUtils.NodeType rootNodeType,
                      DataSet newDataSet)
               throws Exception

Throws:

Exception

parseXml

public DataSetRecord parseXml(XmlUtils xml,
                              org.w3c.dom.Node root,
                              XmlObjectConnectorParams params,
                              Driver driver,
                              Map<Integer,Boolean> types,
                              DataSet dataSet,
                              DataSetRecord record,
                              XmlUtils.NodeType rootNodeType,
                              org.w3c.dom.NodeList nodeList,
                              XmlUtils.NodeType thisNodeType)
                       throws Exception

Parses the xml and creates a hierarchy of the data sets.

Parameters:

xml - the xml

root - the root node

params - the parameters

driver - the etl driver

types - the types

dataSet - the data set

record - the record

rootNodeType - the root node type

nodeList - the node list

thisNodeType - the this node type

Returns:

the data set record

Throws:

Exception - in case of any error

consume

public boolean consume(XmlStreamingPackage streamingPackage,
                       Object message,
                       AtomicInteger row)
                throws Exception

Description copied from interface: StreamingConnector

Consume the next record.

Specified by:

consume in interface StreamingConnector<XmlStreamingPackage,XmlProducerPackage>

Overrides:

consume in class XmlObjectStreamingConnector

Parameters:

streamingPackage - the streaming package

message - the message to consume

row - the current row number

Returns:

true, if successful

Throws:

Exception - in case of any error

populate

public ConnectorResult populate(XmlObjectConnectorParams params,
                                DataSet dataSet,
                                Driver driver)
                         throws Exception

Description copied from interface: DataSetConnector

Populates data set.

Specified by:

populate in interface DataSetConnector<XmlObjectConnectorParams,ConnectorResult>

Overrides:

populate in class XmlObjectStreamingConnector

Parameters:

params - the DataSetConnectorParams

dataSet - the data set

driver - the driver

Returns:

the ConnectorResult

Throws:

Exception - in case of any error

initQueryLabel

public String initQueryLabel()

Description copied from interface: DataSetConnector

The init query label. If not empty the init query, for example XML XQuery, will be enabled and label in editor will be set to the value of this field

Specified by:

initQueryLabel in interface DataSetConnector<XmlObjectConnectorParams,ConnectorResult>

Overrides:

initQueryLabel in class XmlObjectStreamingConnector

Returns:

the string

supportsNested

public boolean supportsNested()

Description copied from interface: DataSetConnector

Supports nested.

Specified by:

supportsNested in interface DataSetConnector<XmlObjectConnectorParams,ConnectorResult>

Overrides:

supportsNested in class XmlObjectStreamingConnector

Returns:

true, if connector supports nested data sets