Packages

  • package root
    Definition Classes
    root
  • package info
    Definition Classes
    root
  • package kwarc
    Definition Classes
    info
  • package mmt
    Definition Classes
    kwarc
  • package api

    This is the main package of the MMT API.

    This is the main package of the MMT API.

    It holds subpackages for all data structures, data containers, and the central algorithms and services.

    Classes directly defined in the package

    Some minor classes that are used throughout MMT are defined in this package, in particular:

    • MMT URIs in the class Path and Namespace
    • processing and content errors in the class Error

    The package also contains root classes for certain types that are subclassed throughout the package. Most importantly:

    • StructuralElement: structure-level (= named) parts in the data structures for the MMT language: documents, theories, constants, ...
    • MMTTask: tasks for a single object: parsing, checking, ...
    • Rule: object-level part of the MMT language that is written in Scala

    Subpackages

    Data structures for the MMT language

    The data structures for the MMT languages are defined in 4 packages corresponding to the 4 levels: - documents: Documents and all other NarrativeElements - modules: Modules (= the toplevel declarations), in particular Theorys and Views - symbols: all Declarations inside modules, in particular Constants - objects: all anonymous Objects (e.g., formulas, functions, etc.), in particular Contexts and Terms

    The former 3 levels are jointly called 'structural' levels. All elements subclass StructuralElement, have an MMT URI, and carry an MMT URI referring to their parent in the MMT abstract syntax tree.

    Structural elements are extensible (via DerivedModules and DerivedDeclarations), and the package patterns defines declaration patterns as a built-in extension.

    All structural elements are mutable and implement the ContainerElement interface for changing their children. Objects, by contrast, are represented as immutable inductive types.(except for carrying metadata.Metadata and objects.ClientProperties). The boundary between structural elements and objects is mediated by ComponentContainers: these are mutable, owned by structural elements, and maintain objects.

    A few auxiliary data structures shifted to separate packages: - opaque: external (i.e., informal, computation) content - informal: partially outdated informal data structures - metadata: metadata annotations to all structural elements or objects

    The MMT main class and its internal state

    The package frontend contains the class Controller, which owns all state relevant for running MMT. Typically, each application creates a single instance of this class. The package also defines several other essential classes, most importantly MMT's extension (=plug-in, add-on) interfaces via the Extension class.

    The package libraries maintains the instances of MMT language data structures, in particular the Library class. Controller owns a Library, which stores all structural elements that have been loaded into memory.

    User interfaces

    The package frontend also contains the main executable classes, in particular the Shell class.

    The package gui collects all classes for building graphical user interfaces. This includes auxiliary classes for use in IDE plugins.

    The package web collects all classes for the HTTP interface of MMT.

    Physical storage of the MMT language files

    The package archives defines MMT Archives (= projects) as well as classes for building and working with archives. The latter include in particular the BuildManager and BuildTarget. Build targets include Importers and [Exporter]]s that translate between MMT and other formats.

    The package backend defines classes for maintaining archives and translating between the MMT URIs of structural elements and their physical storage locations.

    The central algorithms for processing MMT content

    The processing model of MMT consists of several major algorithms. - parser: read strings into MMT data structures - checking: check and refine MMT data structures - uom: pure computation on MMT data structures - proving: theorem proving on MMT data structures (in very early state)) - execution: imperative computation (in very, very early state) - presentation: rendering MMT data structures in user-facing formats (including HTML+presentation MathML)

    All algorithms are defined in Extensions coupled with default implementations. Moreover, all algorithms are split into two separate levels, one for structural elements and objects. See LeveledExtension.

    The package notations maintains the common code for parsing and presentation.

    The package valuebases maintains mathematical databases as a part of MMT.

    Other algorithms on the MMT data structures

    The package ontology contains a relational, semantic web-style ontology and query engine for it.

    The package moc contains change management.

    The package refactoring contains refactoring principles.

    General purpose utility functions

    The package utils defines general purpose APIs for files, URIs, HTML building, etc.

    Definition Classes
    mmt
  • package web

    Server maintains the HTTP interface of MMT.

    Server maintains the HTTP interface of MMT. The server is owned by the frontend.Controller.

    It can be customized by ServerExtensions.

    The REPLServer maintains a set of independent REPL loops for MMT content.

    Definition Classes
    api
  • ActionServer
  • Body
  • BreadcrumbsServer
  • ContextMenuAggregator
  • ContextMenuEntry
  • ContextMenuProvider
  • DirectGraphBuilder
  • FileServer
  • GetActionServer
  • GraphBuilder
  • GraphSolverExtension
  • Graphs
  • JArchiveGraph
  • JDocgraph
  • JGraphBuilder
  • JGraphEdge
  • JGraphExporter
  • JGraphNode
  • JGraphSelector
  • JGraphSideBar
  • JMPDGraph
  • JPgraph
  • JSONBasedGraphServer
  • JThgraph
  • MessageHandler
  • ParseServer
  • PostServer
  • QueryServer
  • REPLServer
  • REPLSession
  • RemoteAdminClient
  • RemoteAdminConnection
  • RemoteAdminServer
  • RequestMethod
  • SVGServer
  • SearchServer
  • Server
  • ServerError
  • ServerExtension
  • ServerImplementation
  • ServerRequest
  • ServerResponse
  • ServerTiscafAdapter
  • Session
  • SimpleJGraphExporter
  • StandardBuilder
  • SubmitCommentServer
  • TEMASearchServer
  • TiscafServerImplementation
  • TreeView
  • URIProducer
  • URIServer
  • Util
  • WebQuery

object ServerResponse

factory methods for typical responses

Source
ServerResponse.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ServerResponse
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def FileResponse(file: File): ServerResponse
  5. def HTMLResponse(text: String): ServerResponse
  6. def JsonResponse(content: JSON): ServerResponse
  7. def ResourceResponse(path: String): ServerResponse

    an MMT resource

    an MMT resource

    path

    path of File to be sent back

  8. def TextResponse(text: String, tp: String = "plain"): ServerResponse
  9. def XmlResponse(node: Node): ServerResponse
  10. def XmlResponse(text: String): ServerResponse
  11. def anyDataResponse(in: InputStream, extension: Option[String]): ServerResponse

    creates a response from a file etc

    creates a response from a file etc

    extension

    file extension (only used to guess a content type)

  12. def apply(content: String, contentType: String, statusCode: Int = statusCodeOK): ServerResponse

    Convenience method to construct a standard response

    Convenience method to construct a standard response

    content

    Textual message to be sent in the HTTP body

    contentType

    contentType of the message to be returned

    statusCode

    statusCode of the message

  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. def errorResponse(error: Error, format: String): ServerResponse

    builds an error response from an error

  18. def errorResponse(msg: String, format: String = "html"): ServerResponse

    builds an error response from an error message

  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. def fromJSON(content: JSON, statusCode: Int = statusCodeOK): ServerResponse

    Convenience method to send application/json back to the client

    Convenience method to send application/json back to the client

    content

    JSON object to send back to the user

    statusCode

    statusCode of the message

  21. def fromText(content: String, contentType: String = "plain", statusCode: Int = statusCodeOK): ServerResponse

    Convenience method to send back a text/ response back to the client.

    Convenience method to send back a text/ response back to the client.

    content

    Textual message to be sent in the HTTP body

    contentType

    Textual content type, will be returned as text/_ in the header

    statusCode

    statusCode of the message

  22. def fromXML(content: Node, statusCode: Int = statusCodeOK): ServerResponse

    Convenience method to send application/xml back to the client

    Convenience method to send application/xml back to the client

    content

    XML object to send back to the user

    statusCode

    statusCode of the message

  23. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. val statusCodeBadGateway: Int
  30. val statusCodeBadRequest: Int
  31. val statusCodeForbidden: Int
  32. val statusCodeInternalServerError: Int
  33. val statusCodeMovedPermanently: Int
  34. val statusCodeNotFound: Int
  35. val statusCodeNotImplemented: Int
  36. val statusCodeOK: Int
  37. val statusCodePermanentRedirect: Int
  38. val statusCodeServiceUnavailable: Int
  39. val statusCodeTemporaryRedirect: Int
  40. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  41. def toString(): String
    Definition Classes
    AnyRef → Any
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped