add diagrams and improve index.md for provider / persist modules
Project: http://git-wip-us.apache.org/repos/asf/incubator-streams/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-streams/commit/a786c8b8 Tree: http://git-wip-us.apache.org/repos/asf/incubator-streams/tree/a786c8b8 Diff: http://git-wip-us.apache.org/repos/asf/incubator-streams/diff/a786c8b8 Branch: refs/heads/STREAMS-389 Commit: a786c8b8c65e080c3a7f2861b22374ed5a674acc Parents: 44bc089 Author: Steve Blackmon @steveblackmon <sblack...@apache.org> Authored: Thu Apr 21 15:28:06 2016 -0500 Committer: Steve Blackmon @steveblackmon <sblack...@apache.org> Committed: Thu Apr 21 15:28:06 2016 -0500 ---------------------------------------------------------------------- .../src/main/resources/components.dot | 31 +++++++++++ .../src/main/resources/kinesis-read.conf | 10 ++++ .../src/site/markdown/index.md | 24 +++++---- .../src/main/resources/components.dot | 32 ++++++++++++ .../src/main/resources/s3-read.conf | 10 ++++ .../src/site/markdown/index.md | 24 +++++---- .../src/main/resources/components.dot | 25 +++++++++ .../src/site/markdown/index.md | 15 ++++++ .../src/site/markdown/index.md | 52 +++++++----------- .../src/main/resources/components.dot | 31 +++++++++++ .../src/main/resources/filebuffer.conf | 3 ++ .../src/site/markdown/index.md | 24 ++++++--- .../src/main/resources/components.dot | 32 ++++++++++++ .../src/main/resources/graph-read.conf | 21 ++++++++ .../src/main/resources/graph-write.conf | 21 ++++++++ .../src/site/markdown/index.md | 55 ++++---------------- .../src/main/resources/components.dot | 29 +++++++++++ .../src/main/resources/hbase.conf | 12 +++++ .../src/site/markdown/index.md | 25 +++++---- .../src/main/resources/components.dot | 32 ++++++++++++ .../src/main/resources/hdfs-read.conf | 8 +++ .../src/main/resources/hdfs-write.conf | 8 +++ .../src/site/markdown/index.md | 31 +++++------ .../src/test/resources/hdfs-read.conf | 9 ++++ .../src/test/resources/hdfs-write.conf | 7 +++ .../src/main/resources/kafka.conf | 6 +++ .../src/site/markdown/index.md | 22 +++++--- .../src/main/resources/components.dot | 32 ++++++++++++ .../src/main/resources/mongo.conf | 6 +++ .../src/main/resources/reference.conf | 8 --- .../src/site/markdown/index.md | 22 +++++--- .../streams-provider-moreover/README.md | 21 +++----- .../src/main/resources/components.dot | 36 +++++++++++++ .../src/main/resources/moreover.conf | 8 +++ .../src/site/markdown/index.md | 17 ++++-- .../src/main/resources/components.dot | 33 ++++++++++++ .../src/site/markdown/index.md | 4 +- 37 files changed, 601 insertions(+), 185 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-amazon-aws/streams-persist-kinesis/src/main/resources/components.dot ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-amazon-aws/streams-persist-kinesis/src/main/resources/components.dot b/streams-contrib/streams-amazon-aws/streams-persist-kinesis/src/main/resources/components.dot new file mode 100644 index 0000000..736c7f4 --- /dev/null +++ b/streams-contrib/streams-amazon-aws/streams-persist-kinesis/src/main/resources/components.dot @@ -0,0 +1,31 @@ +digraph g { + + graph [compound = true]; + + //presentation + splines = true; + overlap = false; + rankdir = TB; + + generators [label="generators", shape="circle"]; + providers [label="providers", shape="circle"]; + processors [label="processors", shape="circle"]; + + subgraph cluster_persisters { + label="persisters"; + persisters_kinesis_reader [label="KinesisPersistReader"] + persisters_kinesis_writer [label="KinesisPersistWriter"] + } + + subgraph cluster_queues { + label="queues"; + kinesis [label="kinesis"] + } + + generators -> providers + providers -> processors + processors -> persisters_kinesis_writer [label="o.a.s.p.StreamsDatum"] + persisters_kinesis_reader -> processors [label="o.a.s.p.StreamsDatum[String]"] + persisters_kinesis_writer -> kinesis + persisters_kinesis_reader <- kinesis +} http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-amazon-aws/streams-persist-kinesis/src/main/resources/kinesis-read.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-amazon-aws/streams-persist-kinesis/src/main/resources/kinesis-read.conf b/streams-contrib/streams-amazon-aws/streams-persist-kinesis/src/main/resources/kinesis-read.conf new file mode 100644 index 0000000..46ca442 --- /dev/null +++ b/streams-contrib/streams-amazon-aws/streams-persist-kinesis/src/main/resources/kinesis-read.conf @@ -0,0 +1,10 @@ +kinesis: { + key: "" + secretKey: "" + protocol: "HTTPS" + region: "us-east-1" + streams = [ + "topic1" + "topic2" + ] +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-amazon-aws/streams-persist-kinesis/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-amazon-aws/streams-persist-kinesis/src/site/markdown/index.md b/streams-contrib/streams-amazon-aws/streams-persist-kinesis/src/site/markdown/index.md index cc64ce9..448b9af 100644 --- a/streams-contrib/streams-amazon-aws/streams-persist-kinesis/src/site/markdown/index.md +++ b/streams-contrib/streams-amazon-aws/streams-persist-kinesis/src/site/markdown/index.md @@ -3,17 +3,19 @@ streams-persist-kinesis Read/Write documents to/from Kinesis. -Example writer configuration: +## Configuration - "kinesis": { - "key": "", - "secretKey": "", - "protocol": "HTTPS", - "region": "us-east-1", - "streams: [ - "topic1", - "topic2" - ] - } +| Schema | +|--------| +| [KinesisConfiguration.json](org/apache/streams/amazon/kinesis/KinesisConfiguration.json "KinesisConfiguration.json") [KinesisConfiguration.html](apidocs/org/apache/streams/amazon/kinesis/KinesisConfiguration.html "javadoc") | + +## Components + +![components](components.dot.svg "Components") + +| Class | Configuration | Example Configuration(s) | +|-------|---------------|--------------------------| +| KinesisPersistReader [KinesisPersistReader.html](apidocs/org/apache/streams/amazon/kinesis/KinesisPersistReader.html "javadoc") | [KinesisReaderConfiguration.json](org/apache/streams/amazon/kinesis/KinesisReaderConfiguration.json "KinesisReaderConfiguration.json") [KinesisReaderConfiguration.html](apidocs/org/apache/streams/amazon/kinesis/KinesisReaderConfiguration.html "javadoc") | [kinesis-read.conf](kinesis-read.conf "kinesis-read.conf") | +| KinesisPersistWriter [KinesisPersistWriter.html](apidocs/org/apache/streams/amazon/kinesis/KinesisPersistWriter "javadoc") | [KinesisWriterConfiguration.json](org/apache/streams/amazon/kinesis/KinesisWriterConfiguration.json "KinesisWriterConfiguration.json") [KinesisWriterConfiguration.html](apidocs/org/apache/streams/amazon/kinesis/KinesisWriterConfiguration.html "javadoc") | [kinesis-write.conf](kinesis-write.conf "kinesis-write.conf") | ###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-amazon-aws/streams-persist-s3/src/main/resources/components.dot ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-amazon-aws/streams-persist-s3/src/main/resources/components.dot b/streams-contrib/streams-amazon-aws/streams-persist-s3/src/main/resources/components.dot new file mode 100644 index 0000000..35c5bed --- /dev/null +++ b/streams-contrib/streams-amazon-aws/streams-persist-s3/src/main/resources/components.dot @@ -0,0 +1,32 @@ +digraph g { + + graph [compound = true]; + + //presentation + splines = true; + overlap = false; + rankdir = TB; + + generators [label="generators", shape="circle"]; + providers [label="providers", shape="circle"]; + processors [label="processors", shape="circle"]; + + subgraph cluster_persisters { + label="persisters"; + persisters_s3_reader [label="S3PersistReader"] + persisters_s3_writer [label="S3PersistWriter"] + } + + subgraph cluster_dbs { + label="dbs"; + s3 [label="s3"] + } + + generators -> providers + providers -> processors + processors -> persisters_s3_writer [label="o.a.s.p.StreamsDatum"] + persisters_s3_reader -> processors [label="o.a.s.p.StreamsDatum[String]"] + persisters_s3_reader <- s3 + persisters_s3_writer -> s3 + +} http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-amazon-aws/streams-persist-s3/src/main/resources/s3-read.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-amazon-aws/streams-persist-s3/src/main/resources/s3-read.conf b/streams-contrib/streams-amazon-aws/streams-persist-s3/src/main/resources/s3-read.conf new file mode 100644 index 0000000..000022b --- /dev/null +++ b/streams-contrib/streams-amazon-aws/streams-persist-s3/src/main/resources/s3-read.conf @@ -0,0 +1,10 @@ +s3: { + key: "", + secretKey: "", + bucket: "", + protocol: "HTTP", + writerPath: "path/", + writerFilePrefix: "prefix", + chunk: false, + region: "us-east-1" +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-amazon-aws/streams-persist-s3/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-amazon-aws/streams-persist-s3/src/site/markdown/index.md b/streams-contrib/streams-amazon-aws/streams-persist-s3/src/site/markdown/index.md index 84b8a76..99e7642 100644 --- a/streams-contrib/streams-amazon-aws/streams-persist-s3/src/site/markdown/index.md +++ b/streams-contrib/streams-amazon-aws/streams-persist-s3/src/site/markdown/index.md @@ -3,17 +3,19 @@ streams-persist-s3 Write documents to an S3 bucket. -Example writer configuration: +## Configuration - "s3": { - "key": "", - "secretKey": "", - "bucket": "", - "protocol": "HTTP", - "writerPath": "path/", - "writerFilePrefix": "prefix", - "chunk": false, - "region": "us-east-1" - } +| Schema | +|--------| +| [S3Configuration.json](org/apache/streams/s3/S3Configuration.json "S3Configuration.json") [S3Configuration.html](apidocs/org/apache/streams/s3/S3Configuration.html "javadoc") | + +## Components + +![components](components.dot.svg "Components") + +| Class | Configuration | Example Configuration(s) | +|-------|---------------|--------------------------| +| S3PersistReader [S3PersistReader.html](apidocs/org/apache/streams/s3/S3PersistReader.html "javadoc") | [KinesisReaderConfiguration.json](org/apache/streams/s3/KinesisReaderConfiguration.json "KinesisReaderConfiguration.json") [KinesisReaderConfiguration.html](apidocs/org/apache/streams/s3/KinesisReaderConfiguration.html "javadoc") | [s3-read.conf](s3-read.conf "s3-read.conf") | +| S3PersistWriter [S3PersistWriter.html](apidocs/org/apache/streams/s3/S3PersistWriter "javadoc") | [KinesisWriterConfiguration.json](org/apache/streams/s3/KinesisWriterConfiguration.json "KinesisWriterConfiguration.json") [KinesisWriterConfiguration.html](apidocs/org/apache/streams/s3/KinesisWriterConfiguration.html "javadoc") | [s3-write.conf](s3-write.conf "s3-write.conf") | ###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-console/src/main/resources/components.dot ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-console/src/main/resources/components.dot b/streams-contrib/streams-persist-console/src/main/resources/components.dot new file mode 100644 index 0000000..64e696d --- /dev/null +++ b/streams-contrib/streams-persist-console/src/main/resources/components.dot @@ -0,0 +1,25 @@ +digraph g { + + graph [compound = true]; + + //presentation + splines = true; + overlap = false; + rankdir = TB; + + generators [label="generators", shape="circle"]; + providers [label="providers", shape="circle"]; + processors [label="processors", shape="circle"]; + + subgraph cluster_persisters { + label="persisters"; + persisters_console_reader [label="KinesisPersistReader"] + persisters_console_writer [label="KinesisPersistWriter"] + } + + generators -> providers + providers -> processors + processors -> persisters_console_writer [label="o.a.s.p.StreamsDatum"] + persisters_console_reader -> processors [label="o.a.s.p.StreamsDatum[String]"] + +} http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-console/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-console/src/site/markdown/index.md b/streams-contrib/streams-persist-console/src/site/markdown/index.md new file mode 100644 index 0000000..130f339 --- /dev/null +++ b/streams-contrib/streams-persist-console/src/site/markdown/index.md @@ -0,0 +1,15 @@ +streams-persist-console +======================= + +Read/Write documents to/from console. + +## Components + +![components](components.dot.svg "Components") + +| Class | +|-------| +| ConsolePersistReader [ConsolePersistReader.html](apidocs/org/apache/streams/console/ConsolePersistReader.html "javadoc") +| ConsolePersistWriter [ConsolePersistWriter.html](apidocs/org/apache/streams/console/ConsolePersistWriter "javadoc") + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-elasticsearch/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-elasticsearch/src/site/markdown/index.md b/streams-contrib/streams-persist-elasticsearch/src/site/markdown/index.md index 5771838..d059572 100644 --- a/streams-contrib/streams-persist-elasticsearch/src/site/markdown/index.md +++ b/streams-contrib/streams-persist-elasticsearch/src/site/markdown/index.md @@ -1,39 +1,23 @@ streams-persist-elasticsearch ===================== -Read and write to Elasticsearch - -Example reader configuration: - - "elasticsearch": { - "hosts": [ - "localhost" - ], - "port": 9300, - "clusterName": "elasticsearch", - "indexes": [ - "sourceindex" - ], - "types": [ - "sourcetype" - ], - "_search": { - "query" : { - "match_all" : { } - } - } - } - -Example writer configuration: - - "elasticsearch": { - "hosts": [ - "localhost" - ], - "port": 9300, - "clusterName": "elasticsearch", - "index": "destinationindex", - "type": "destinationtype - } +Read/write to/from Elasticsearch + +## Configuration + +| Schema | +|--------| +| [ElasticsearchConfiguration.json](org/apache/streams/elasticsearch/ElasticsearchConfiguration.json "ElasticsearchConfiguration.json") [ElasticsearchConfiguration.html](apidocs/org/apache/streams/elasticsearch/ElasticsearchConfiguration.html "javadoc") | + +## Components + +![components](components.dot.svg "Components") + +| Class | Configuration | Example Configuration(s) | +|-------|---------------|--------------------------| +| ElasticsearchPersistReader [ElasticsearchPersistReader.html](apidocs/org/apache/streams/elasticsearch/ElasticsearchPersistReader.html "javadoc") | [ElasticsearchReaderConfiguration.json](org/apache/streams/elasticsearch/ElasticsearchReaderConfiguration.json "ElasticsearchReaderConfiguration.json") [ElasticsearchReaderConfiguration.html](apidocs/org/apache/streams/elasticsearch/ElasticsearchReaderConfiguration.html "javadoc") | [elasticsearch-read.conf](elasticsearch-read.conf "elasticsearch-read.conf") | +| ElasticsearchPersistWriter [ElasticsearchPersistWriter.html](apidocs/org/apache/streams/elasticsearch/ElasticsearchPersistWriter "javadoc") | [ElasticsearchWriterConfiguration.json](org/apache/streams/elasticsearch/ElasticsearchWriterConfiguration.json "ElasticsearchWriterConfiguration.json") [ElasticsearchWriterConfiguration.html](apidocs/org/apache/streams/elasticsearch/ElasticsearchWriterConfiguration.html "javadoc") | [elasticsearch-write.conf](elasticsearch-write.conf "elasticsearch-write.conf") | +| ElasticsearchPersistUpdater [ElasticsearchPersistUpdater.html](apidocs/org/apache/streams/elasticsearch/ElasticsearchPersistUpdater "javadoc") | [ElasticsearchWriterConfiguration.json](org/apache/streams/elasticsearch/ElasticsearchWriterConfiguration.json "ElasticsearchWriterConfiguration.json") [ElasticsearchWriterConfiguration.html](apidocs/org/apache/streams/elasticsearch/ElasticsearchWriterConfiguration.html "javadoc") | [elasticsearch-write.conf](elasticsearch-write.conf "elasticsearch-write.conf") | + ###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-filebuffer/src/main/resources/components.dot ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-filebuffer/src/main/resources/components.dot b/streams-contrib/streams-persist-filebuffer/src/main/resources/components.dot new file mode 100644 index 0000000..9cdbf1e --- /dev/null +++ b/streams-contrib/streams-persist-filebuffer/src/main/resources/components.dot @@ -0,0 +1,31 @@ +digraph g { + + graph [compound = true]; + + //presentation + splines = true; + overlap = false; + rankdir = TB; + + generators [label="generators", shape="circle"]; + providers [label="providers", shape="circle"]; + processors [label="processors", shape="circle"]; + + subgraph cluster_persisters { + label="persisters"; + persisters_filebuffer_reader [label="FileBufferPersistReader"] + persisters_filebuffer_writer [label="FileBufferPersistWriter"] + } + + subgraph cluster_queues { + label="queues"; + filebuffer [label="filebuffer"] + } + + generators -> providers + providers -> processors + processors -> persisters_filebuffer_writer [label="o.a.s.p.StreamsDatum"] + persisters_filebuffer_reader -> processors [label="o.a.s.p.StreamsDatum[String]"] + persisters_filebuffer_writer -> filebuffer + persisters_filebuffer_reader <- filebuffer +} http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-filebuffer/src/main/resources/filebuffer.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-filebuffer/src/main/resources/filebuffer.conf b/streams-contrib/streams-persist-filebuffer/src/main/resources/filebuffer.conf new file mode 100644 index 0000000..b0252f4 --- /dev/null +++ b/streams-contrib/streams-persist-filebuffer/src/main/resources/filebuffer.conf @@ -0,0 +1,3 @@ +file { + path = "/tmp/file-queue.txt" +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-filebuffer/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-filebuffer/src/site/markdown/index.md b/streams-contrib/streams-persist-filebuffer/src/site/markdown/index.md index 6634d72..af57978 100644 --- a/streams-contrib/streams-persist-filebuffer/src/site/markdown/index.md +++ b/streams-contrib/streams-persist-filebuffer/src/site/markdown/index.md @@ -1,14 +1,22 @@ -streams-persist-file -===================== +streams-persist-filebuffer +========================== Read to / write from File-backed Queue -Example reader/writer configuration: +## Configuration + +| Schema | +|--------| +| [FileBufferConfiguration.json](org/apache/streams/file/FileBufferConfiguration.json "FileBufferConfiguration.json") [FileBufferConfiguration.html](apidocs/org/apache/streams/file/FileBufferConfiguration.html "javadoc") | + +## Components + +![components](components.dot.svg "Components") + +| Class | Configuration | Example Configuration(s) | +|-------|---------------|--------------------------| +| FileBufferPersistReader [FileBufferPersistReader.html](apidocs/org/apache/streams/file/FileBufferPersistReader.html "javadoc") | [FileBufferReaderConfiguration.json](org/apache/streams/file/FileBufferReaderConfiguration.json "FileBufferReaderConfiguration.json") [FileBufferReaderConfiguration.html](apidocs/org/apache/streams/file/FileBufferReaderConfiguration.html "javadoc") | [filebuffer.conf](filebuffer.conf "filebuffer.conf") | +| FileBufferPersistWriter [FileBufferPersistWriter.html](apidocs/org/apache/streams/file/FileBufferPersistWriter "javadoc") | [FileBufferWriterConfiguration.json](org/apache/streams/file/FileBufferWriterConfiguration.json "FileBufferWriterConfiguration.json") [FileBufferWriterConfiguration.html](apidocs/org/apache/streams/file/FileBufferWriterConfiguration.html "javadoc") | [filebuffer.conf](filebuffer.conf "filebuffer.conf") | - file { - path = "/tmp/file-queue.txt" - } - -Reader will consume lines from Writer ###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-graph/src/main/resources/components.dot ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-graph/src/main/resources/components.dot b/streams-contrib/streams-persist-graph/src/main/resources/components.dot new file mode 100644 index 0000000..956b4a4 --- /dev/null +++ b/streams-contrib/streams-persist-graph/src/main/resources/components.dot @@ -0,0 +1,32 @@ +digraph g { + + graph [compound = true]; + + //presentation + splines = true; + overlap = false; + rankdir = TB; + + generators [label="generators", shape="circle"]; + providers [label="providers", shape="circle"]; + processors [label="processors", shape="circle"]; + + subgraph cluster_persisters { + label="persisters"; + persisters_graph_reader [label="GraphVertexReader"] + persisters_graph_writer [label="GraphHttpWriter"] + } + + subgraph cluster_dbs { + label="dbs"; + neo4j [label="neo4j"] + } + + generators -> providers + providers -> processors + processors -> persisters_graph_writer [label="o.a.s.p.StreamsDatum"] + persisters_graph_reader -> processors [label="o.a.s.p.StreamsDatum"] + persisters_graph_reader <- neo4j + persisters_graph_writer -> neo4j + +} http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-graph/src/main/resources/graph-read.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-graph/src/main/resources/graph-read.conf b/streams-contrib/streams-persist-graph/src/main/resources/graph-read.conf new file mode 100644 index 0000000..e1946fa --- /dev/null +++ b/streams-contrib/streams-persist-graph/src/main/resources/graph-read.conf @@ -0,0 +1,21 @@ +{ + "graph": { + "type": "neo4j", + "protocol": "http", + "hostname": "localhost", + "port": 7474, + "graph": "data" + "query": { + "objects": [ + "actor", + "object" + ], + "verbs": [ + "follow" + ], + "objectTypes": [ + "page" + ] + } + } +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-graph/src/main/resources/graph-write.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-graph/src/main/resources/graph-write.conf b/streams-contrib/streams-persist-graph/src/main/resources/graph-write.conf new file mode 100644 index 0000000..bce608b --- /dev/null +++ b/streams-contrib/streams-persist-graph/src/main/resources/graph-write.conf @@ -0,0 +1,21 @@ +{ + "graph": { + "type": "neo4j", + "protocol": "http", + "hostname": "localhost", + "port": 7474, + "graph": "data" + "vertices": { + "objects": [ + "actor", + "object" + ], + "verbs": [ + "follow" + ], + "objectTypes": [ + "page" + ] + } + } +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-graph/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-graph/src/site/markdown/index.md b/streams-contrib/streams-persist-graph/src/site/markdown/index.md index 1073696..c534f5f 100644 --- a/streams-contrib/streams-persist-graph/src/site/markdown/index.md +++ b/streams-contrib/streams-persist-graph/src/site/markdown/index.md @@ -3,52 +3,19 @@ streams-persist-graph Build a graph index of a stream -Example Neo4J writer configuration: +## Configuration - { - "graph": { - "type": "neo4j", - "protocol": "http", - "hostname": "localhost", - "port": 7474, - "graph": "data" - "vertices": { - "objects": [ - "actor", - "object" - ], - "verbs": [ - "follow" - ], - "objectTypes": [ - "page" - ] - } - }, - } +| Schema | +|--------| +| [GraphConfiguration.json](org/apache/streams/graph/GraphConfiguration.json "GraphConfiguration.json") [GraphConfiguration.html](apidocs/org/apache/streams/graph/GraphConfiguration.html "javadoc") | -Example Neo4J reader configuration: +## Components - { - "graph": { - "type": "neo4j", - "protocol": "http", - "hostname": "localhost", - "port": 7474, - "graph": "data" - "query": { - "objects": [ - "actor", - "object" - ], - "verbs": [ - "follow" - ], - "objectTypes": [ - "page" - ] - } - }, - } +![components](components.dot.svg "Components") + +| Class | Configuration | Example Configuration(s) | +|-------|---------------|--------------------------| +| GraphVertexReader [GraphVertexReader.html](apidocs/org/apache/streams/graph/GraphVertexReader.html "javadoc") | [GraphReaderConfiguration.json](org/apache/streams/graph/GraphReaderConfiguration.json "GraphReaderConfiguration.json") [GraphReaderConfiguration.html](apidocs/org/apache/streams/graph/GraphReaderConfiguration.html "javadoc") | [graph-read.conf](graph-read.conf "graph-read.conf") | +| GraphHttpPersistWriter [GraphHttpPersistWriter.html](apidocs/org/apache/streams/graph/GraphHttpPersistWriter "javadoc") | [GraphHttpConfiguration.json](org/apache/streams/graph/GraphHttpConfiguration.json "GraphHttpConfiguration.json") [GraphHttpConfiguration.html](apidocs/org/apache/streams/graph/GraphHttpConfiguration.html "javadoc") | [graph-write.conf](graph-write.conf "graph-write.conf") | ###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-hbase/src/main/resources/components.dot ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-hbase/src/main/resources/components.dot b/streams-contrib/streams-persist-hbase/src/main/resources/components.dot new file mode 100644 index 0000000..28e116e --- /dev/null +++ b/streams-contrib/streams-persist-hbase/src/main/resources/components.dot @@ -0,0 +1,29 @@ +digraph g { + + graph [compound = true]; + + //presentation + splines = true; + overlap = false; + rankdir = TB; + + generators [label="generators", shape="circle"]; + providers [label="providers", shape="circle"]; + processors [label="processors", shape="circle"]; + + subgraph cluster_persisters { + label="persisters"; + persisters_hbase_writer [label="HbasePersistWriter"] + } + + subgraph cluster_dbs { + label="dbs"; + hbase [label="hbase"] + } + + generators -> providers + providers -> processors + processors -> persisters_hbase_writer [label="o.a.s.p.StreamsDatum[String]\no.a.s.p.StreamsDatum[ObjectNode]"] + persisters_hbase_writer -> hbase + +} http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-hbase/src/main/resources/hbase.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-hbase/src/main/resources/hbase.conf b/streams-contrib/streams-persist-hbase/src/main/resources/hbase.conf new file mode 100644 index 0000000..ebcf6ff --- /dev/null +++ b/streams-contrib/streams-persist-hbase/src/main/resources/hbase.conf @@ -0,0 +1,12 @@ +hbase { + rootdir = "hdfs://cloudera-vm-local:8020/hbase" + zookeeper { + quorum = "cloudera-vm-local" + property { + clientPort = 2181 + } + } + table = "test_table" + family = "test_family" + qualifier = "test_column" +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-hbase/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-hbase/src/site/markdown/index.md b/streams-contrib/streams-persist-hbase/src/site/markdown/index.md index 8892566..e50d8d3 100644 --- a/streams-contrib/streams-persist-hbase/src/site/markdown/index.md +++ b/streams-contrib/streams-persist-hbase/src/site/markdown/index.md @@ -3,19 +3,18 @@ streams-persist-hbase Read and write to HBase -Example reader or writer configuration: +## Configuration - hbase { - rootdir = "hdfs://cloudera-vm-local:8020/hbase" - zookeeper { - quorum = "cloudera-vm-local" - property { - clientPort = 2181 - } - } - table = "test_table" - family = "test_family" - qualifier = "test_column" - } +| Schema | +|--------| +| [HbaseConfiguration.json](org/apache/streams/hbase/HbaseConfiguration.json "HbaseConfiguration.json") [HbaseConfiguration.html](apidocs/org/apache/streams/hbase/HbaseConfiguration.html "javadoc") | + +## Components + +![components](components.dot.svg "Components") + +| Class | Configuration | Example Configuration(s) | +|-------|---------------|--------------------------| +| HbasePersistWriter [HbasePersistWriter.html](apidocs/org/apache/streams/hbase/HbasePersistWriter "javadoc") | [HbaseConfiguration.json](org/apache/streams/hbase/HbaseConfiguration.json "HbaseConfiguration.json") [HbaseConfiguration.html](apidocs/org/apache/streams/hbase/HbaseConfiguration.html "javadoc") | [hbase.conf](hbase.conf "hbase.conf") | ###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-hdfs/src/main/resources/components.dot ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-hdfs/src/main/resources/components.dot b/streams-contrib/streams-persist-hdfs/src/main/resources/components.dot new file mode 100644 index 0000000..4c3a8ea --- /dev/null +++ b/streams-contrib/streams-persist-hdfs/src/main/resources/components.dot @@ -0,0 +1,32 @@ +digraph g { + + graph [compound = true]; + + //presentation + splines = true; + overlap = false; + rankdir = TB; + + generators [label="generators", shape="circle"]; + providers [label="providers", shape="circle"]; + processors [label="processors", shape="circle"]; + + subgraph cluster_persisters { + label="persisters"; + persisters_hdfs_reader [label="WebHdfsPersistReader"] + persisters_hdfs_writer [label="WebHdfsPersistWriter"] + } + + subgraph cluster_dbs { + label="dbs"; + hdfs [label="hdfs"] + } + + generators -> providers + providers -> processors + processors -> persisters_hdfs_writer [label="o.a.s.p.StreamsDatum"] + persisters_hdfs_reader -> processors [label="o.a.s.p.StreamsDatum"] + persisters_hdfs_reader <- hdfs + persisters_hdfs_writer -> hdfs + +} http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-hdfs/src/main/resources/hdfs-read.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-hdfs/src/main/resources/hdfs-read.conf b/streams-contrib/streams-persist-hdfs/src/main/resources/hdfs-read.conf new file mode 100644 index 0000000..b716abf --- /dev/null +++ b/streams-contrib/streams-persist-hdfs/src/main/resources/hdfs-read.conf @@ -0,0 +1,8 @@ +hdfs: { + scheme: "hdfs" + host: "hadoop", + port: "8020", + user: "hadoop", + path: "/user/hadoop", + readerPath: "inputDir" +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-hdfs/src/main/resources/hdfs-write.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-hdfs/src/main/resources/hdfs-write.conf b/streams-contrib/streams-persist-hdfs/src/main/resources/hdfs-write.conf new file mode 100644 index 0000000..799919f --- /dev/null +++ b/streams-contrib/streams-persist-hdfs/src/main/resources/hdfs-write.conf @@ -0,0 +1,8 @@ +hdfs: { + scheme: "hdfs" + host: "hadoop", + port: "8020", + user: "hadoop", + path: "/user/hadoop", + writerPath: "outputDir" +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-hdfs/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-hdfs/src/site/markdown/index.md b/streams-contrib/streams-persist-hdfs/src/site/markdown/index.md index 9393409..77556a8 100644 --- a/streams-contrib/streams-persist-hdfs/src/site/markdown/index.md +++ b/streams-contrib/streams-persist-hdfs/src/site/markdown/index.md @@ -3,26 +3,19 @@ streams-persist-hdfs Read and write to HDFS -Example reader configuration: +## Configuration - hdfs { - host = "localhost" - port = "50070" - path = "/user/cloudera" - user = "cloudera" - password = "cloudera" - } - -Example writer configuration: +| Schema | +|--------| +| [HdfsConfiguration.json](org/apache/streams/s3/HdfsConfiguration.json "HdfsConfiguration.json") [HdfsConfiguration.html](apidocs/org/apache/streams/s3/HdfsConfiguration.html "javadoc") | + +## Components + +![components](components.dot.svg "Components") - hdfs { - host = "localhost" - port = "50070" - path = "/user/cloudera" - user = "cloudera" - password = "cloudera" - writerPath = "/history/twitter/example" - writerFilePrefix = "streams-" - } +| Class | Configuration | Example Configuration(s) | +|-------|---------------|--------------------------| +| WebHdfsPersistReader [WebHdfsPersistReader.html](apidocs/org/apache/streams/hdfs/WebHdfsPersistReader.html "javadoc") | [HdfsReaderConfiguration.json](org/apache/streams/hdfs/HdfsReaderConfiguration.json "HdfsReaderConfiguration.json") [HdfsReaderConfiguration.html](apidocs/org/apache/streams/hdfs/HdfsReaderConfiguration.html "javadoc") | [hdfs-read.conf](hdfs-read.conf "hdfs-read.conf") | +| WebHdfsPersistWriter [WebHdfsPersistWriter.html](apidocs/org/apache/streams/hdfs/WebHdfsPersistWriter "javadoc") | [HdfsWriterConfiguration.json](org/apache/streams/hdfs/HdfsWriterConfiguration.json "HdfsWriterConfiguration.json") [HdfsWriterConfiguration.html](apidocs/org/apache/streams/hdfs/HdfsWriterConfiguration.html "javadoc") | [hdfs-write.conf](hdfs-write.conf "hdfs-write.conf") | ###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-hdfs/src/test/resources/hdfs-read.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-hdfs/src/test/resources/hdfs-read.conf b/streams-contrib/streams-persist-hdfs/src/test/resources/hdfs-read.conf new file mode 100644 index 0000000..b3d54d1 --- /dev/null +++ b/streams-contrib/streams-persist-hdfs/src/test/resources/hdfs-read.conf @@ -0,0 +1,9 @@ +hdfs { + host = "localhost" + port = "50070" + path = "/user/cloudera" + user = "cloudera" + password = "cloudera" + writerPath = "/history/twitter/example" + writerFilePrefix = "streams-" +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-hdfs/src/test/resources/hdfs-write.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-hdfs/src/test/resources/hdfs-write.conf b/streams-contrib/streams-persist-hdfs/src/test/resources/hdfs-write.conf new file mode 100644 index 0000000..f011d48 --- /dev/null +++ b/streams-contrib/streams-persist-hdfs/src/test/resources/hdfs-write.conf @@ -0,0 +1,7 @@ +hdfs { + host = "localhost" + port = "50070" + path = "/user/cloudera" + user = "cloudera" + password = "cloudera" +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-kafka/src/main/resources/kafka.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-kafka/src/main/resources/kafka.conf b/streams-contrib/streams-persist-kafka/src/main/resources/kafka.conf new file mode 100644 index 0000000..87ad284 --- /dev/null +++ b/streams-contrib/streams-persist-kafka/src/main/resources/kafka.conf @@ -0,0 +1,6 @@ +kafka { + brokerlist = "localhost:9092" + zkconnect = "localhost:2181" + topic = "topic" + groupId = "group" +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-kafka/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-kafka/src/site/markdown/index.md b/streams-contrib/streams-persist-kafka/src/site/markdown/index.md index 0c99458..c7b70ac 100644 --- a/streams-contrib/streams-persist-kafka/src/site/markdown/index.md +++ b/streams-contrib/streams-persist-kafka/src/site/markdown/index.md @@ -1,15 +1,21 @@ streams-persist-kafka ===================== -Read and write to Kafka +Read/write to/from Kafka -Example reader / writer configuration: +## Configuration - kafka { - brokerlist = "localhost:9092" - zkconnect = "localhost:2181" - topic = "topic" - groupId = "group" - } +| Schema | +|--------| +| [KafkaConfiguration.json](org/apache/streams/kafka/KafkaConfiguration.json "KafkaConfiguration.json") [KafkaConfiguration.html](apidocs/org/apache/streams/kafka/KafkaConfiguration.html "javadoc") | + +## Components + +![components](components.dot.svg "Components") + +| Class | +|-------| +| KafkaPersistReader [KafkaPersistReader.html](apidocs/org/apache/streams/kafka/KafkaPersistReader.html "javadoc") +| KafkaPersistWriter [KafkaPersistWriter.html](apidocs/org/apache/streams/kafka/KafkaPersistWriter.html "javadoc") ###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-mongo/src/main/resources/components.dot ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-mongo/src/main/resources/components.dot b/streams-contrib/streams-persist-mongo/src/main/resources/components.dot new file mode 100644 index 0000000..c01921d --- /dev/null +++ b/streams-contrib/streams-persist-mongo/src/main/resources/components.dot @@ -0,0 +1,32 @@ +digraph g { + + graph [compound = true]; + + //presentation + splines = true; + overlap = false; + rankdir = TB; + + generators [label="generators", shape="circle"]; + providers [label="providers", shape="circle"]; + processors [label="processors", shape="circle"]; + + subgraph cluster_persisters { + label="persisters"; + persisters_mongo_reader [label="MongoPersistReader"] + persisters_mongo_writer [label="MongoPersistWriter"] + } + + subgraph cluster_dbs { + label="dbs"; + mongo [label="mongo"] + } + + generators -> providers + providers -> processors + processors -> persisters_mongo_writer [label="o.a.s.p.StreamsDatum"] + persisters_mongo_reader -> processors [label="o.a.s.p.StreamsDatum[String]"] + persisters_mongo_reader <- mongo + persisters_mongo_writer -> mongo + +} http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-mongo/src/main/resources/mongo.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-mongo/src/main/resources/mongo.conf b/streams-contrib/streams-persist-mongo/src/main/resources/mongo.conf new file mode 100644 index 0000000..4533b68 --- /dev/null +++ b/streams-contrib/streams-persist-mongo/src/main/resources/mongo.conf @@ -0,0 +1,6 @@ +"mongo": { + "host": "localhost", + "port": 27017, + "db": "local", + "collection": "startup_log" +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-mongo/src/main/resources/reference.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-mongo/src/main/resources/reference.conf b/streams-contrib/streams-persist-mongo/src/main/resources/reference.conf deleted file mode 100644 index fca2903..0000000 --- a/streams-contrib/streams-persist-mongo/src/main/resources/reference.conf +++ /dev/null @@ -1,8 +0,0 @@ -# Apache Streams (incubating) -# Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 -"mongo": { - "host": "localhost", - "port": 27017, - "db": "local", - "collection": "startup_log" -} http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-persist-mongo/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-mongo/src/site/markdown/index.md b/streams-contrib/streams-persist-mongo/src/site/markdown/index.md index aa582cf..6cf978d 100644 --- a/streams-contrib/streams-persist-mongo/src/site/markdown/index.md +++ b/streams-contrib/streams-persist-mongo/src/site/markdown/index.md @@ -1,15 +1,21 @@ streams-persist-mongo ===================== -Read and write to MongoDB +Read/write to/from MongoDB -Example configuration: +## Configuration - "mongo": { - "host": "localhost", - "port": 27017, - "db": "local", - "collection": "startup_log" - } +| Schema | +|--------| +| [MongoConfiguration.json](org/apache/streams/mongo/MongoConfiguration.json "MongoConfiguration.json") [MongoConfiguration.html](apidocs/org/apache/streams/mongo/MongoConfiguration.html "javadoc") | + +## Components + +![components](components.dot.svg "Components") + +| Class | +|-------| +| MongoPersistReader [MongoPersistReader.html](apidocs/org/apache/streams/mongo/MongoPersistReader.html "javadoc") +| MongoPersistWriter [MongoPersistWriter.html](apidocs/org/apache/streams/mongo/MongoPersistWriter.html "javadoc") ###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-provider-moreover/README.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-moreover/README.md b/streams-contrib/streams-provider-moreover/README.md index d7fcbfb..765a1e4 100644 --- a/streams-contrib/streams-provider-moreover/README.md +++ b/streams-contrib/streams-provider-moreover/README.md @@ -1,17 +1,8 @@ -streams-provider-moreover -========================== +Apache Streams (incubating) +Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 +-------------------------------------------------------------------------------- -Purpose +org.apache.streams:streams-provider-moreover +============================================ - Module connects to moreover API, collects events, converts to activity, and passes each activity downstream. - -Example configuration - - moreover { - â â apiKeys { - key { - key = "" - startingSequence = "" - } - } - } \ No newline at end of file +[README.md](src/site/markdown/index.md "README") http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-provider-moreover/src/main/resources/components.dot ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-moreover/src/main/resources/components.dot b/streams-contrib/streams-provider-moreover/src/main/resources/components.dot new file mode 100644 index 0000000..6b33ce2 --- /dev/null +++ b/streams-contrib/streams-provider-moreover/src/main/resources/components.dot @@ -0,0 +1,36 @@ +digraph g { + + graph [compound = true]; + + //presentation + splines = true; + overlap = false; + rankdir = TB; + + subgraph cluster_generators { + label="generators"; + style="dotted"; + generators_moreover [label="https://api.moreover.com"] + } + + subgraph cluster_providers { + label="providers"; + providers_moreover [label="MoreoverProvider"] + } + + subgraph cluster_processors { + label="processors"; + processors_moreover_jsonconverter [label="MoreoverJsonActivitySerializer"] + processors_moreover_xmlconverter [label="MoreoverXmlActivitySerializer"] + } + + persisters [label="persisters", shape="cylinder"]; + + generators_moreover -> providers_moreover + providers_moreover -> processors_moreover_jsonconverter [label="c.m.Moreover"] + providers_moreover -> processors_moreover_xmlconverter [label="c.m.a.Article"] + + processors_moreover_jsonconverter -> persisters [label="o.a.s.p.j.Activity"] + processors_moreover_xmlconverter -> persisters [label="o.a.s.p.j.Activity"] + +} http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-provider-moreover/src/main/resources/moreover.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-moreover/src/main/resources/moreover.conf b/streams-contrib/streams-provider-moreover/src/main/resources/moreover.conf new file mode 100644 index 0000000..4e2f138 --- /dev/null +++ b/streams-contrib/streams-provider-moreover/src/main/resources/moreover.conf @@ -0,0 +1,8 @@ +moreover { + apiKeys { + key { + key = "" + startingSequence = "" + } + } +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-provider-moreover/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-moreover/src/site/markdown/index.md b/streams-contrib/streams-provider-moreover/src/site/markdown/index.md index d4a7f11..0258d10 100644 --- a/streams-contrib/streams-provider-moreover/src/site/markdown/index.md +++ b/streams-contrib/streams-provider-moreover/src/site/markdown/index.md @@ -3,10 +3,21 @@ streams-provider-moreover streams-provider-moreover contains schema definitions, providers, conversions, and utility classes. -##Schemas +## Data Types -[Moreover.json](com/moreover/Moreover.json "Moreover.json") +| Schema | +|--------| +| [Moreover.json](com/moreover/Moreover.json "Moreover.json") [Moreover.json.html](apidocs/com/moreover/Moreover.html "javadoc") | +| [articles10.xsd](com/moreover/articles10.xsd "articles10.xsd") [Moreover.xsd.html](apidocs/com/moreover/api/Article.html "javadoc") | -[articles10.xsd](com/moreover/articles10.xsd "articles10.xsd") +## Configuration + +| Schema | +|--------| +| [MoreoverConfiguration.json](org/apache/streams/moreover/MoreoverConfiguration.json "MoreoverConfiguration.json") [MoreoverConfiguration.html](apidocs/org/apache/streams/moreover/MoreoverConfiguration.html "javadoc") | + +## Components + +![components](components.dot.svg "Components") ###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-provider-sysomos/src/main/resources/components.dot ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-sysomos/src/main/resources/components.dot b/streams-contrib/streams-provider-sysomos/src/main/resources/components.dot new file mode 100644 index 0000000..d130bc4 --- /dev/null +++ b/streams-contrib/streams-provider-sysomos/src/main/resources/components.dot @@ -0,0 +1,33 @@ +digraph g { + + graph [compound = true]; + + //presentation + splines = true; + overlap = false; + rankdir = TB; + + subgraph cluster_generators { + label="generators"; + style="dotted"; + generators_sysomos [label="https://api.sysomos.com"] + } + + subgraph cluster_providers { + label="providers"; + providers_sysomos [label="SysomosProvider"] + } + + subgraph cluster_processors { + label="processors"; + processors_sysomos_typeconveter [label="SysomosTypeConverter"] + } + + persisters [label="persisters", shape="cylinder"]; + + generators_sysomos -> providers_sysomos + providers_sysomos -> processors_sysomos_typeconveter [label="c.s.x.BeatApi.BeatResponse.Beat"] + + processors_sysomos_typeconveter -> persisters [label="o.a.s.p.j.Activity"] + +} http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/a786c8b8/streams-contrib/streams-provider-sysomos/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-sysomos/src/site/markdown/index.md b/streams-contrib/streams-provider-sysomos/src/site/markdown/index.md index 0858493..f048064 100644 --- a/streams-contrib/streams-provider-sysomos/src/site/markdown/index.md +++ b/streams-contrib/streams-provider-sysomos/src/site/markdown/index.md @@ -18,9 +18,7 @@ streams-provider-sysomos contains schema definitions, providers, conversions, an ## Components -| Class | Configuration | Example Configuration(s) | -|-------|---------------|--------------------------| -| SysomosProvider [SysomosProvider.html](apidocs/org/apache/streams/sysomos/SysomosProvider.html "javadoc") | [SysomosConfiguration.json](com/sysomos/SysomosConfiguration.json "SysomosConfiguration.json") [SysomosConfiguration.html](apidocs/com/sysomos/SysomosConfiguration.html "javadoc") | [sysomos.conf](sysomos.conf "sysomos.conf") | +![components](components.dot.svg "Components") ###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0