Merge branch 'release/1.0.0'

demokratie-live · Jan 8, 2019 · b60ff4b · b60ff4b
2 parents 57af017 + 4572858
commit b60ff4b
Show file tree

Hide file tree

Showing 16 changed files with 5,537 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,5 @@
+node_modules/
+dist/
+*.js
+*.d.ts
+*.svg
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,4 @@
+tsconfig.json
+src
+files
+.vscode
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,5 @@
+{
+    "files.exclude": {
+        "**/node_modules": true,
+    }
+}
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -0,0 +1,19 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "type": "typescript",
+            "tsconfig": "tsconfig.json",
+            "option": "watch",
+            "problemMatcher": [
+                "$tsc-watch"
+            ],
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            }
+        }
+    ]
+}
diff --git a/doc/Browser.plantuml b/doc/Browser.plantuml
@@ -0,0 +1,22 @@
+@startuml Browser
+  package Browser {    
+    note top of IBrowser
+      Navigiert in einer Struktur und liefert die gewünschten IFile-Fragmente.  
+    end note
+
+    interface IBrowser<T extends IFile> {
+      void load(uri: URI)
+      boolean hasNext()
+      T next()
+    }
+
+    class DipBrowser<Html> {
+    }
+
+    class PlenarProtocolBrowser<Xml> {
+    }
+
+    IBrowser <|-- DipBrowser
+    IBrowser <|-- PlenarProtocolBrowser
+  }
+@enduml
diff --git a/doc/Importer model for semi-structured data sources (german).pptx b/doc/Importer model for semi-structured data sources (german).pptx
diff --git a/doc/Importer.plantuml b/doc/Importer.plantuml
@@ -0,0 +1,93 @@
+@startuml Importer
+package Importer {
+  package Parser {
+    note top of IParser
+      Extrahiert die gewünschten Daten aus dem gegebenen IFile.
+    end note
+
+    interface IParser<T extends IFile> {
+      JSON parse(content: T) 
+    }
+
+    class DipProcedureDataParser<Html> {
+    }
+
+    class PlenarProtocolSpeechesParser<Xml> {
+    }
+
+    IParser <|-- DipProcedureDataParser
+    IParser <|-- PlenarProtocolSpeechesParser
+  }
+
+  package Browser {    
+    note top of IBrowser
+      Navigiert in einer Struktur und liefert die gewünschten IFile-Fragmente.  
+    end note
+
+    interface IBrowser<T extends IFile> {
+      void load(uri: URI)
+      boolean hasNext()
+      T next()
+    }
+
+    class DipBrowser<Html> {
+    }
+
+    class PlenarProtocolBrowser<Xml> {
+    }
+
+    IBrowser <|-- DipBrowser
+    IBrowser <|-- PlenarProtocolBrowser
+  }
+
+  package Scraper {
+    note top of IScraper
+      Sammelt die Daten aus verschiedenen Quellen zusammen.
+    end note
+
+    interface IScraper {
+      + JSON[]: scrape(configs: ScraperConfiguration[])
+    }
+
+    interface IScraperConfiguration<T extends IFile> {
+      URI getUri()
+      IBrowser<T> getBrowser()
+      IParser<T> getParser()
+    }
+
+    IScraper "1" -> "*" IScraperConfiguration
+
+    class DipProcedureScraperConfiguration<Html> {
+      IBrowser<Html> getBrowser()
+      IParser<Html> getParser()
+    }
+
+    class PlenarProtocolSpeechScraperConfiguration<Xml> {
+      IBrowser<Xml> getBrowser()
+      IParser<Xml> getParser()
+    }
+
+    IScraperConfiguration <|-- DipProcedureScraperConfiguration
+    IScraperConfiguration <|-- PlenarProtocolSpeechScraperConfiguration
+
+    interface IFile {
+    }
+
+    class Html {
+    }
+
+    class Xml {
+    }
+
+    'class Pdf {
+    '}
+
+    Html --|> IFile
+    Xml --|> IFile
+    'Pdf --|> IFile
+
+    IScraperConfiguration *- IFile
+  }
+}
+
+@enduml
diff --git a/doc/Parser.plantuml b/doc/Parser.plantuml
@@ -0,0 +1,20 @@
+@startuml Parser
+  package Parser {
+    note top of IParser
+      Extrahiert die gewünschten Daten aus dem gegebenen IFile.
+    end note
+
+    interface IParser<T extends IFile> {
+      JSON parse(content: T) 
+    }
+
+    class DipProcedureDataParser<Html> {
+    }
+
+    class PlenarProtocolSpeechesParser<Xml> {
+    }
+
+    IParser <|-- DipProcedureDataParser
+    IParser <|-- PlenarProtocolSpeechesParser
+  }
+@enduml
diff --git a/doc/Scraper.plantuml b/doc/Scraper.plantuml
@@ -0,0 +1,50 @@
+@startuml Scraper
+  package Scraper {
+    note top of IScraper
+      Sammelt die Daten aus verschiedenen Quellen zusammen.
+    end note
+
+    interface IScraper {
+      + JSON[]: scrape(configs: ScraperConfiguration[])
+    }
+
+    interface IScraperConfiguration<T extends IDataFormat> {
+      URI getUri()
+      IBrowser<T> getBrowser()
+      IParser<T> getParser()
+    }
+
+    IScraper "1" -> "*" IScraperConfiguration
+
+    class DipProcedureScraperConfiguration<Html> {
+      IBrowser<Html> getBrowser()
+      IParser<Html> getParser()
+    }
+
+    class PlenarProtocolSpeechScraperConfiguration<Xml> {
+      IBrowser<Xml> getBrowser()
+      IParser<Xml> getParser()
+    }
+
+    IScraperConfiguration <|-- DipProcedureScraperConfiguration
+    IScraperConfiguration <|-- PlenarProtocolSpeechScraperConfiguration
+
+    interface IDataFormat {
+    }
+
+    class Html {
+    }
+
+    class Xml {
+    }
+
+    'class Pdf {
+    '}
+
+    Html --|> IDataFormat
+    Xml --|> IDataFormat
+    'Pdf --|> IDataFormat
+
+    IScraperConfiguration *- IDataFormat
+  }
+@enduml