apex-malhar git commit: APEXMALHAR-2370 Documentation of Xml Parser

[ra...@apache.org]

Repository: apex-malhar
Updated Branches:
  refs/heads/master 0500e0ea4 -> 964079f45


APEXMALHAR-2370 Documentation of Xml Parser


Project: http://git-wip-us.apache.org/repos/asf/apex-malhar/repo
Commit: http://git-wip-us.apache.org/repos/asf/apex-malhar/commit/964079f4
Tree: http://git-wip-us.apache.org/repos/asf/apex-malhar/tree/964079f4
Diff: http://git-wip-us.apache.org/repos/asf/apex-malhar/diff/964079f4

Branch: refs/heads/master
Commit: 964079f45dab4b8008003e539d251056b22a6a08
Parents: 0500e0e
Author: Hitesh-Scorpio <fo...@gmail.com>
Authored: Mon Dec 19 14:44:56 2016 +0530
Committer: Hitesh-Scorpio <fo...@gmail.com>
Committed: Mon Dec 26 14:42:44 2016 +0530

----------------------------------------------------------------------
 docs/operators/images/xmlParser/XmlParser.png | Bin 0 -> 22196 bytes
 docs/operators/xmlParserOperator.md           |  82 +++++++++++++++++++++
 mkdocs.yml                                    |   1 +
 3 files changed, 83 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/apex-malhar/blob/964079f4/docs/operators/images/xmlParser/XmlParser.png
----------------------------------------------------------------------
diff --git a/docs/operators/images/xmlParser/XmlParser.png b/docs/operators/images/xmlParser/XmlParser.png
new file mode 100644
index 0000000..3964da9
Binary files /dev/null and b/docs/operators/images/xmlParser/XmlParser.png differ

http://git-wip-us.apache.org/repos/asf/apex-malhar/blob/964079f4/docs/operators/xmlParserOperator.md
----------------------------------------------------------------------
diff --git a/docs/operators/xmlParserOperator.md b/docs/operators/xmlParserOperator.md
new file mode 100644
index 0000000..14c2ee3
--- /dev/null
+++ b/docs/operators/xmlParserOperator.md
@@ -0,0 +1,82 @@
+Xml Parser
+=============
+
+## Operator Objective
+The XmlParser operator parses XML records and constructs POJOs ("Plain Old Java Objects") from them. The operator also emits each record as a DOM Document if the relevant output port is connected. User can also provide a XSD (XML Schema Definition) to validate incoming XML records. Valid records will be emitted as POJOs / DOM Document while invalid ones are emitted on error port with an error message if the error port is connected.
+
+XmlParser is **idempotent**, **fault-tolerant** and **statically/dynamically partitionable**.
+
+## Class Diagram
+![](images/xmlParser/XmlParser.png)
+## Operator Information
+1. Operator location: **_malhar-library_**
+2. Available since: **_3.2.0_**
+3. Operator state: **_Evolving_**
+4. Java Package: [com.datatorrent.lib.parser.XmlParser](https://github.com/apache/apex-malhar/blob/master/library/src/main/java/com/datatorrent/lib/parser/XmlParser.java)
+
+## Properties, Attributes and Ports
+### <a name="props"></a>Properties of Xml Parser
+| **Property** | **Description** | **Type** | **Mandatory** | **Default Value** |
+| -------- | ----------- | ---- | ------------------ | ------------- |
+| *schemaXSDFile* | [XSD] describing XML data. Incoming records can be validated using the schemaXSDFile. If the data is not as per the requirements specified in schemaXSDFile, they are emitted on the error port. This is an optional property. If the XSD is not provided, incoming tuples are simply converted to POJOs or DOM Documents without any validations| String | No | N/A |
+
+### Platform Attributes that influence operator behavior
+| **Attribute** | **Description** | **Type** | **Mandatory** |
+| -------- | ----------- | ---- | ------------------ |
+| *out.TUPLE_CLASS* | TUPLE_CLASS attribute on output port which tells operator the class of POJO which needs to be emitted. The name of the field members of the class must match with the names in incoming POJO. The operator ignores unknown properties i.e. fields present in POJO but not in TUPLE_CLASS or vice versa.| Class or FQCN| Yes |
+
+
+### Ports
+| **Port** | **Description** | **Type** | **Mandatory** |
+| -------- | ----------- | ---- | ------------------ |
+| *in*  | Tuples that needs to be parsed are received on this port | byte[] | Yes
+| *out* | Valid Tuples that are emitted as pojo. Tuples are converted to POJO only if the port is connected. | Object (POJO) | No |
+| *parsedOutput* | Valid Tuples that are emitted as DOM Document. Tuples are converted to DOM Document only if the port is connected.| DOM Document | No |
+| *err* | Invalid Tuples are emitted with error message. Invalid tuples are discarded if the port is not connected. | KeyValPair <String, String\> | No |
+
+## Partitioning
+XML Parser is both statically and dynamically partitionable.
+### Static Partitioning
+This can be achieved in 2 ways
+
+1. Specifying the partitioner and number of partitions in the 'populateDAG()' method.
+```java
+XmlParser xmlParser = dag.addOperator("xmlParser", XmlParser.class);
+StatelessPartitioner<XmlParser> partitioner1 = new StatelessPartitioner<XmlParser>(2);
+dag.setAttribute(xmlParser, Context.OperatorContext.PARTITIONER, partitioner1 );
+```
+2. Specifying the partitioner and number of partitions in properties file.
+```xml
+ <property>
+   <name>dt.operator.{OperatorName}.attr.PARTITIONER</name>
+   <value>com.datatorrent.common.partitioner.StatelessPartitioner:2</value>
+ </property>
+```
+ where {OperatorName} is the name of the XmlParser operator.
+ Above lines will partition XmlParser statically 2 times. Above value can be changed accordingly to change the number of static partitions.
+
+
+### Dynamic Partitioning
+
+XmlParser can be dynamically partitioned using an out-of-the-box partitioner:
+
+#### Throughput based
+Following code can be added to 'populateDAG' method of application to dynamically partition XmlParser:
+```java
+XmlParser xmlParser = dag.addOperator("xmlParser", XmlParser.class);
+StatelessThroughputBasedPartitioner<XmlParser> partitioner = new StatelessThroughputBasedPartitioner<>();
+partitioner.setCooldownMillis(conf.getLong("dt.cooldown", 10000));
+partitioner.setMaximumEvents(conf.getLong("dt.maxThroughput", 30000));
+partitioner.setMinimumEvents(conf.getLong("dt.minThroughput", 10000));
+dag.setAttribute(xmlParser, OperatorContext.STATS_LISTENERS, Arrays.asList(new StatsListener[]{partitioner}));
+dag.setAttribute(xmlParser, OperatorContext.PARTITIONER, partitioner);
+```
+
+Above code will dynamically partition XmlParser when the throughput changes.
+If the overall throughput of XmlParser goes beyond 30000 or less than 10000, the platform will repartition XmlParser
+to balance throughput of a single partition to be between 10000 and 30000.
+'dt.cooldown' of 10000 will be used as the threshold time for which the throughput change is observed.
+
+
+## Example
+Example for Xml Parser can be found at: [https://github.com/DataTorrent/examples/tree/master/tutorials/parser](https://github.com/DataTorrent/examples/tree/master/tutorials/parser)

http://git-wip-us.apache.org/repos/asf/apex-malhar/blob/964079f4/mkdocs.yml
----------------------------------------------------------------------
diff --git a/mkdocs.yml b/mkdocs.yml
index 175850a..d19cb7c 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -18,4 +18,5 @@ pages:
     - Json Parser: operators/jsonParser.md
     - Json Formatter: operators/jsonFormatter.md
     - Transform Operator: operators/transform.md
+    - Xml Parser: operators/xmlParserOperator.md