Changes between Version 3 and Version 4 of mpdl2.0-design

Timestamp:

Sep 6, 2011, 11:14:23 AM (13 years ago)

Author:

jwillenborg

Comment:

--

mpdl2.0-design

@@ -1 @@
-= MPDL 2.0 =
-
-The MPDL backend software release 2.0 is redesigned so that important functions (language technology, XML functions) are available as web applications independent from the eXist software - usable as HTTP servlets and fully implemented in Java.
+= MPDL 2.0 (backend system) =
+
+The MPDL backend software is redesigned so that as much software as possible is separated from the eXist database system and could be used independently from eXist (MPDL 2.0). We offer two MPDL librares: 
+* language technology (available as a web archive file "mpiwg-mpdl-lt.war") 
+* XML technology (available as a web archive file "mpiwg-mpdl-xml.war")
+
+The other MPDL backend software which needs the functionality of eXist and Lucene (XML document storage and retrieval) is redesigned so that all important functions are available as HTTP servlets with a specified API.
 
 == Language technology ==
 
-The language technology module consists of:
-* language technology data (XML data files, Java Berkely DB's)
+The language technology web archive ""mpiwg-mpdl-lt.war"" consists of:
+* data (data files, Java Berkely DB's)
   * morphology data (Perseus, CELEX, Lexique with languages: ara, eng, fre, ger, gre, ita, lat, nld, zho)
   * dictionary data (dictionaries: autenrieth, baretti, bonitz, cooper, florio, lewis-short, lidell-scott-jones, salmone, webster)
 * Java source code
 * used Java libraries
-* web application configuration file (web.xml)
-
-It is available as the web archive file "mpiwg-mpdl-lt.war".
-
-Following servlets are available:
+* web application configuration file ("web.xml")
+
+Following HTTP servlets are available:
 
 === Morphology === 
@@ -66 +68 @@
   * URL: /mpdl/getDictionaryEntries
   * Request parameters:
-    * forms or lemmas
+    * forms or lemmas or range
       * one form or lemma (string)
       * list of forms or lemmas (XML)
+      * range 
+        * entries beginning with, e.g. "a*"
+        * entries from position x to y: e.g. "200-300"
     * inputType (optional; default: "form")
       * "form", "lemma"
     * dictionary (optional; default: all dictionaries)
-      * dictionary name (e.g. "webster")
+      * dictionary name, e.g. "webster"
     * language (optional, default: all languages)
       * ISO 639-3 specifier
     * outputType (optional)
-      * full, compact
+      * "full", "compact"
+    * outputFormat (optional)
+      * "xml", "html"
     * normalization (optional; default: without normalization) 
       * "reg", "norm", "reg norm" 
   * Response output:
     * dictionary entries
-      * dictionary entries (XML)
+      * dictionary entries (XML/HTML format)
+        * if result is big then it is devided into result pages
+        * with external links
 
 * !DictionaryEnrichServlet
@@ -124 +133 @@
 == XML technology ==
 
-The XML technology module consists of:
+The XML technology web archive ""mpiwg-mpdl-xml.war"" consists of:
 * Java source code
 * used Java libraries
-* web application configuration file (web.xml)
-
-It is available as the web archive file "mpiwg-mpdl-xml.war".
-
-Following servlets are available:
+* web application configuration file ("web.xml")
+
+Following HTTP servlets are available:
 
 === XPath/XQuery ===
@@ -189 +196 @@
     * XML fragment
 
+== XML document storage and retrieval ==
+
+* !GetDocumentServlet
+  * URL: /mpdl/getDoc
+  * Request parameters:
+    * docId
+      * document identifier (e.g. "/echo/la/benedetti_1585.xml")
+  * Response output:
+    * document
+
+* !DocumentOperationServlet
+  * URL: /mpdl/documentOperation
+  * Request parameters:
+    * operation
+      * "create", "update", "delete"
+    * srcUrl
+      * source URL of XML document e.g. "http://yourServer/Benedetti_1585.xml"
+    * destFileName (optional: default: file name in URL)
+      * destination file name, e.g. "benedetti_1585.xml"
+    * destLanguage (optional, default: xml:lang in document or "eng")
+      * destination language (ISO 639-3 specifier), e.g. "lat"
+  * Response output:
+    * job id of scheduled operation
+
+* !QueryServlet
+  * URL: /mpdl/query
+  * Request parameters:
+    * queryType (optional: default: "morphological normalized")
+      * "exact", "morphological", "normalized"
+    * query
+      * attribute query (e.g. "author = 'Benedetti' and language = 'lat'")
+      * fulltext query (e.g. "quantitas")
+    * docbases (optional, default: all document bases)
+      * document bases (e.g. "mpdl", "archimedes-project")
+    * orderBy (optional)
+      * order query result by fieldname: e.g. "author" or "score" (fulltext queries)
+    * resultPageNumber (optional, default: 1)
+      * query result hits: page number
+    * resultPageSize (optional, default: 100)
+      * query result hits: page size
+  * Response output:
+    * query result (XML format)
+
+* !QueryDocumentServlet
+  * URL: /mpdl/queryDoc
+  * Request parameters:
+    * docId
+      * document identifier (e.g. "/echo/la/benedetti_1585.xml")
+    * query
+      * fulltext query (e.g. "quantitas")
+      * morphological fulltext query (e.g. "quantitas")
+    * resultPageNumber (optional, default: 1)
+      * query result hits: page number
+    * resultPageSize (optional, default: 100)
+      * query result hits: page size
+  * Response output:
+    * query result (XML format)