wiki:mpdl2.0-design

Context Navigation

Version 12 (modified by jwillenborg, 13 years ago) (diff)
--

MPDL 2.0 backend system: software design

The MPDL backend software is redesigned so that as much software as possible is separated from the content management system and could be used independently from it. We offer two MPDL librares:

XML technology (available as a basic Java library "mpiwg-mpdl-xml.jar" and as a web archive "mpiwg-mpdl-xml-web.war")
language technology (available as a basic Java library "mpiwg-mpdl-lt.jar" and as a web archive "mpiwg-mpdl-lt-web.war")

Dependent from the CMS we offer the MPDL CMS library:

CMS technology (available as a basic Java library "mpiwg-mpdl-cms.jar" and as a web archive "mpiwg-mpdl-cms-web.war")

XML technology

The XML technology web archive ""mpiwg-mpdl-xml-web.war"" consists of:

Basic Java code: mpiwg-mpdl-xml.jar
- de.mpg.mpiwg.berlin.mpdl.xml.transform
- de.mpg.mpiwg.berlin.mpdl.xml.xquery
- de.mpg.mpiwg.berlin.mpdl.xml.pdf
Web Java code: mpiwg-mpdl-xml-web.jar
- de.mpg.mpiwg.berlin.mpdl.servlets.xml
external Java libraries
- saxon9-s9api.jar
- saxon9.jar
web application configuration file: web.xml

Following HTTP servlets are available:

XSL transformation

Url: /mpiwg-mpdl-xml-web/transform/Transform
- Request parameters:
  - srcUrl
    - source URL of XML document
  - xslUrl
    - URL of XSL document
  - parameters (optional)
    - list of parameters, e.g. "yourParam1=val1 yourParam2=val2"
  - outputProperties (optional)
    - list of output properties, e.g. "method=xhtml indent=no"
- Response output:
  - transformed document (HTML, XML, etc.)

Url: /mpiwg-mpdl-xml-web/transform/GetFragment
- Request parameters:
  - docId
    - document identifier (e.g. "/echo/la/Benedetti_1585.xml")
  - ms1Name
    - first milestone name, e.g. "pb"
  - ms1Position
    - first milestone position, e.g. 1
  - ms2Name
    - second milestone name, e.g. "pb"
  - ms2Position
    - second milestone position, e.g. 2
- Response output:
  - XML fragment

PDF rendering

Url: /mpiwg-mpdl-xml-web/pdf/Render
- Request parameters:
  - srcUrl
    - source URL of XML document
  - xslUrl
    - URL of XSL document
  - parameters (optional)
    - list of parameters, e.g. "yourParam1=val1 yourParam2=val2"
- Response output:
  - rendered document (PDF)

XPath/XQuery

Url: /mpiwg-mpdl-xml-web/xquery/XPath
- Request parameters:
  - srcUrl
    - source URL of XML document
  - xpath
    - xpath source code
- Response output:
  - XPath result for that document

Url: /mpiwg-mpdl-xml-web/xquery/XQuery
- Request parameters:
  - srcUrl
    - source URL of XML document
  - xquery
    - xquery source code
- Response output:
  - XQuery result for that document

Language technology

The language technology web archive ""mpiwg-mpdl-lt-web.war"" consists of:

data (data files, Java BerkelyDB data)
- 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)
Basic Java code: mpiwg-mpdl-lt.jar
- de.mpg.mpiwg.berlin.mpdl.lt.*
Web Java code: mpiwg-mpdl-lt-web.jar
- de.mpg.mpiwg.berlin.mpdl.servlets.lt.*
external Java libraries
- berkeley-db-3.3.82.jar
- ...
web application configuration file: web.xml

Following HTTP servlets are available:

Morphology

Url: /mpiwg-mpdl-lt-web/lt/Tokenize
- Request parameters:
  - srcUrl
    - source URL of fulltext
      - unstructured text
      - XML fragment/document
  - language (if available use xml:lang in XML document else this language value)
    - ISO 639-3 specifier
  - normalization (optional; default: without normalization)
    - "reg", "norm", "reg norm"
  - dictionary (optional; default: with dictionary)
    - "yes", "no"
  - stopElements (optional, default: empty)
    - elements which should not be analyzed and enriched (e.g. "lb")
  - outputFormat (optional; default: "xml")
    - "xml", "wordList"
- Response output:
  - xml
    - document enriched by element <w>
      - e.g. <s><w lang="deu" reg="dies" norm="dies" forms="dies, dieser, dieses, diesen" lemmas="dieser" dictionaries="dwds">Dies</w> <w lang="deu" reg="ist" norm="ist" forms="bin, bist, ist, seid, sind, sein, war, warst, wart" lemmas="sein" dictionaries="dwds">ist</w> <w lang="deu" reg="ein" norm="ein" forms="ein, eines, einer" lemmas="ein" dictionaries="dwds">ein</w> <w lang="deu" reg="satz" norm="satz" forms="satz, sätze, satzes" lemmas="satz" dictionaries="dwds">Satz</w></s>
  - wordList
    - word tokens (separated by Blank)
    - word tokens (XML)

Url: /mpiwg-mpdl-lt-web/lt/GetLemmas
- Request parameters:
  - forms
    - one word form (string)
    - list of word forms (XML)
  - language
    - ISO 639-3 specifier
  - normalization (optional; default: without normalization)
    - "reg", "norm", "reg norm"
- Response output:
  - lemmas
    - one lemma
    - list of lemmas (XML)

Url: /mpiwg-mpdl-lt-web/lt/GetForms
- Request parameters:
  - lemmas
    - one lemma (string)
    - list of lemmas (XML)
  - language
    - ISO 639-3 specifier
  - normalization (optional; default: without normalization)
    - "reg", "norm", "reg norm"
- Response output:
  - forms
    - list forms (XML)

Dictionary

Url: /mpiwg-mpdl-lt-web/lt/GetDictionaryEntries
- Request parameters:
  - query (forms or lemmas or range)
    - one form or lemma (e.g. "revolution")
    - list of forms or lemmas (e.g. "revolution equality brotherliness")
    - range
      - entries beginning with, e.g. "a*"
      - entries from position x to y: e.g. "200-300"
  - inputType (optional; default: "form")
    - "form", "lemma"
  - language (optional, default: eng)
    - ISO 639-3 specifier
  - dictionary (optional; default: all dictionaries for the language)
    - dictionary name, e.g. "webster"
  - outputType (optional, default: compact)
    - "full", "compact"
  - outputFormat (optional, default: xml)
    - "xml", "html"
  - normalization (optional; default: without normalization)
    - "reg", "norm", "reg norm"
- Response output:
  - dictionary entries
    - dictionary entries (in XML/HTML format)
      - if result is big then it is devided into result pages
      - with external links

Text functions

Url: /mpiwg-mpdl-lt-web/text/Normalize
- Request parameters:
  - srcUrl
    - source URL of XML fragment/document
  - method
    - method of normalization (e.g. "reg", "norm", "reg norm")
  - type
    - type of normalization (e.g. "display", "dictionary", "search")
- Response output:
  - normalized XML fragment/document

Url: /mpiwg-mpdl-lt-web/text/Transcode
- URL: /mpdl/transcode
- Request parameters:
  - text
    - text to be transcoded (string)
  - srcEncoding
    - source encoding (e.g. "betacode", "buckwalter", "unicode")
  - destEncoding
    - destination encoding (e.g. "betacode", "buckwalter", "unicode")
- Response output:
  - transcoded text

CMS technology

The CMS technology web archive ""mpiwg-mpdl-cms.war"" consists of:

Basic Java code: mpiwg-mpdl-cms.jar
- de.mpg.mpiwg.berlin.mpdl.cms.*
Web Java code: mpiwg-mpdl-lt-web.jar
- de.mpg.mpiwg.berlin.mpdl.servlets.cms.*
external Java libraries
- mpiwg-mpdl-xml.jar
- mpiwg-mpdl-lt.jar
- ...
web application configuration file: web.xml

Following HTTP servlets are available:

Url: /mpiwg-mpdl-cms-web/cms/GetDocument
- Request parameters:
  - docId
    - document identifier (e.g. "/echo/la/Benedetti_1585.xml")
- Response output:
  - document

Url: /mpiwg-mpdl-cms-web/cms/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

Url: /mpiwg-mpdl-cms-web/cms/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)

Url: /mpiwg-mpdl-cms-web/cms/QueryDocument
- 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)

Download in other formats:

Plain Text