Packages

c

info.kwarc.mmt.mathhub.library.Context

MathHubAPIContext

class MathHubAPIContext extends Logger with Builder

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MathHubAPIContext
  2. Builder
  3. NestedModuleBuilder
  4. RuleBuilder
  5. ConstantBuilder
  6. StructureBuilder
  7. DeclarationWrap
  8. ViewBuilder
  9. TheoryBuilder
  10. ModuleWrap
  11. OpaqueBuilder
  12. DocumentBuilder
  13. ArchiveBuilder
  14. TagBuilder
  15. GroupBuilder
  16. GroupsBuilder
  17. Statistics
  18. Getters
  19. Cache
  20. Logger
  21. AnyRef
  22. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MathHubAPIContext(controller: Controller, report: Report)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def buildArchive(entry: LMHHubArchiveEntry): Option[IArchive]

    builds an archive object

    builds an archive object

    Attributes
    protected
    Definition Classes
    ArchiveBuilder
  6. def buildArchiveReference(entry: LMHHubArchiveEntry): Option[IArchiveRef]

    builds a reference to an archive

    builds a reference to an archive

    Attributes
    protected
    Definition Classes
    ArchiveBuilder
  7. def buildConstant(constant: Constant): Option[IConstant]

    builds a constant representation

    builds a constant representation

    Attributes
    protected
    Definition Classes
    ConstantBuilder
  8. def buildConstantReference(constant: Constant): Option[IDeclarationRef]

    builds a reference to a constant

    builds a reference to a constant

    Attributes
    protected
    Definition Classes
    ConstantBuilder
  9. def buildDocument(document: Document): Option[IDocument]

    builds a document representation

    builds a document representation

    Attributes
    protected
    Definition Classes
    DocumentBuilder
  10. def buildDocumentReference(document: Document): Option[IDocumentRef]

    builds a reference to a document

    builds a reference to a document

    Attributes
    protected
    Definition Classes
    DocumentBuilder
  11. def buildFailure(uri: String, during: String): Option[Nothing]

    indicates that a failure has occured during then build

    indicates that a failure has occured during then build

    Attributes
    protected
    Definition Classes
    Builder
  12. def buildGroup(entry: LMHHubGroupEntry): Option[IGroup]

    builds a group representation

    builds a group representation

    Attributes
    protected
    Definition Classes
    GroupBuilder
  13. def buildGroupReference(entry: LMHHubGroupEntry): Option[IGroupRef]

    builds a reference to a group

    builds a reference to a group

    Attributes
    protected
    Definition Classes
    GroupBuilder
  14. def buildNestedModule(nested: NestedModule): Option[INestedModule]

    builds a rule representation

    builds a rule representation

    Attributes
    protected
    Definition Classes
    NestedModuleBuilder
  15. def buildNestedModuleReference(nested: NestedModule): Option[IDeclarationRef]

    builds a reference to a nested module

    builds a reference to a nested module

    Attributes
    protected
    Definition Classes
    NestedModuleBuilder
  16. def buildOpaque(opaque: OpaqueElement): Option[IOpaqueElement]

    builds an opaque representation

    builds an opaque representation

    Attributes
    protected
    Definition Classes
    OpaqueBuilder
  17. def buildOpaqueReference(opaque: OpaqueElement): Option[IOpaqueElementRef]

    builds a reference to an opaque element

    builds a reference to an opaque element

    Attributes
    protected
    Definition Classes
    OpaqueBuilder
  18. def buildPseudoDocument(path: DPath, text: String): IDocument

    builds a pseudo-document containing specific text

    builds a pseudo-document containing specific text

    Attributes
    protected
    Definition Classes
    DocumentBuilder
  19. def buildRule(rule: RuleConstant): Option[IRule]

    builds a rule representation

    builds a rule representation

    Attributes
    protected
    Definition Classes
    RuleBuilder
  20. def buildRuleReference(rule: RuleConstant): Option[IDeclarationRef]

    builds a reference to a rule

    builds a reference to a rule

    Attributes
    protected
    Definition Classes
    RuleBuilder
  21. def buildStructure(structure: Structure): Option[IStructure]

    builds a structure representation

    builds a structure representation

    Attributes
    protected
    Definition Classes
    StructureBuilder
  22. def buildStructureReference(structure: Structure): Option[IDeclarationRef]

    builds a reference to a structure

    builds a reference to a structure

    Attributes
    protected
    Definition Classes
    StructureBuilder
  23. def buildTag(tag: String): Option[ITag]

    builds a tag

    builds a tag

    Attributes
    protected
    Definition Classes
    TagBuilder
  24. def buildTagReference(tag: String): Option[ITagRef]

    builds a reference to a tag group

    builds a reference to a tag group

    Attributes
    protected
    Definition Classes
    TagBuilder
  25. def buildTheory(theory: Theory): Option[ITheory]

    builds a theory representation

    builds a theory representation

    Attributes
    protected
    Definition Classes
    TheoryBuilder
  26. def buildTheoryReference(theory: Theory): Option[IModuleRef]

    builds a reference to a theory

    builds a reference to a theory

    Attributes
    protected
    Definition Classes
    TheoryBuilder
  27. def buildView(view: View): Option[IView]

    builds a view representation

    builds a view representation

    Attributes
    protected
    Definition Classes
    ViewBuilder
  28. def buildViewReference(view: View): Option[IModuleRef]

    builds a reference to a view

    builds a reference to a view

    Attributes
    protected
    Definition Classes
    ViewBuilder
  29. def clearCache(): Unit

    removes all items from the cache

    removes all items from the cache

    Definition Classes
    Cache
  30. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  31. val controller: Controller
    Definition Classes
    MathHubAPIContextBuilder
  32. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  34. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  35. def getArchive(id: String): Option[IArchive]

    gets an archive

    gets an archive

    Definition Classes
    ArchiveBuilder
  36. def getArchiveRef(id: String): Option[IArchiveRef]

    gets a reference to an archive

    gets a reference to an archive

    Definition Classes
    ArchiveBuilder
  37. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  38. def getComponents(declaration: Declaration): List[IComponent]

    gets a list of components

    gets a list of components

    Attributes
    protected
    Definition Classes
    DeclarationWrap
  39. def getConstant(id: String): Option[IConstant]

    gets a structure

    gets a structure

    Definition Classes
    ConstantBuilder
  40. def getConstantRef(id: String): Option[IDeclarationRef]

    gets a reference to a constant

    gets a reference to a constant

    Definition Classes
    ConstantBuilder
  41. def getDeclaration(id: String): Option[IDeclaration]

    gets a module

    gets a module

    Definition Classes
    DeclarationWrap
  42. def getDeclarationRef(id: String): Option[IDeclarationRef]

    gets a reference to a module

    gets a reference to a module

    Definition Classes
    DeclarationWrap
  43. def getDeclarations(element: ContentElement): List[IDeclarationRef]

    gets the declarations within a content element

    gets the declarations within a content element

    Attributes
    protected
    Definition Classes
    ModuleWrap
  44. def getDocument(id: String): Option[IDocument]

    gets a document

    gets a document

    Definition Classes
    DocumentBuilder
  45. def getDocumentRef(id: String): Option[IDocumentRef]

    gets a reference to a document

    gets a reference to a document

    Definition Classes
    DocumentBuilder
  46. def getDocumentReference(dRef: DRef): Option[IDocumentRef]

    optimisation to quickly build a reference to a parent without loading more content

    optimisation to quickly build a reference to a parent without loading more content

    Attributes
    protected
    Definition Classes
    DocumentBuilder
  47. def getGroup(id: String): Option[IGroup]

    gets a group

    gets a group

    Definition Classes
    GroupBuilder
  48. def getGroupRef(id: String): Option[IGroupRef]

    gets a reference to a group

    gets a reference to a group

    Definition Classes
    GroupBuilder
  49. def getGroups(): List[IGroupRef]
    Definition Classes
    GroupsBuilder
  50. def getHubObject(id: String): Option[IReferencable]

    gets a hub object (i.e.

    gets a hub object (i.e. archive, tag, group)

    Definition Classes
    Builder
  51. def getHubReference(id: String): Option[IReference]

    gets a reference to a hub element

    gets a reference to a hub element

    Definition Classes
    Builder
  52. def getLibraryObject(path: Path, id: String): Option[IReferencable]

    gets an object from the library

    gets an object from the library

    Definition Classes
    Builder
  53. def getLibraryReference(path: Path): Option[IReference]
    Definition Classes
    Builder
  54. def getLibraryReference(path: Path, id: String): Option[IReference]

    gets a reference to a library element

    gets a reference to a library element

    Definition Classes
    Builder
  55. def getModule(id: String): Option[IModule]

    gets a module

    gets a module

    Definition Classes
    ModuleWrap
  56. def getModuleRef(id: String): Option[IModuleRef]

    gets a reference to a module

    gets a reference to a module

    Definition Classes
    ModuleWrap
  57. def getModuleReference(mref: MRef): Option[IModuleRef]

    gets a reference to a module with as few references as possible

    gets a reference to a module with as few references as possible

    Definition Classes
    ModuleWrap
  58. def getNestedModule(id: String): Option[INestedModule]

    gets a nested module

    gets a nested module

    Definition Classes
    NestedModuleBuilder
  59. def getNestedModuleRef(id: String): Option[IDeclarationRef]

    gets a reference to a nested module

    gets a reference to a nested module

    Definition Classes
    NestedModuleBuilder
  60. def getObject(id: String): Option[IReferencable]

    gets an object, either from the cache or newly built

    gets an object, either from the cache or newly built

    Definition Classes
    Builder
  61. def getObjectOf[T <: IReferencable](cls: Class[T], id: String): Option[T]

    gets an object of a specific type

    gets an object of a specific type

    Attributes
    protected
    Definition Classes
    Getters
  62. def getObjectOrElse[T <: IReferencable](cls: Class[T], id: String)(default: ⇒ Option[T]): Option[T]

    Gets a reference of a given type or stores default as the type

    Gets a reference of a given type or stores default as the type

    Attributes
    protected
    Definition Classes
    Getters
  63. def getOpaqueElement(id: String): Option[IOpaqueElement]

    gets an opaque element

    gets an opaque element

    Definition Classes
    OpaqueBuilder
  64. def getOpaqueElementRef(id: String): Option[IOpaqueElementRef]

    gets a reference to an opaque element

    gets a reference to an opaque element

    Definition Classes
    OpaqueBuilder
  65. def getReference(id: String): Option[IReference]

    gets a reference to an object, either from the cache or newly built

    gets a reference to an object, either from the cache or newly built

    Definition Classes
    Builder
  66. def getReferenceOf[T <: IReference](cls: Class[T], id: String): Option[T]

    gets a reference of a specific type

    gets a reference of a specific type

    Attributes
    protected
    Definition Classes
    Getters
  67. def getReferenceOrElse[T <: IReference](cls: Class[T], id: String)(default: ⇒ Option[T]): Option[T]

    Gets a reference of a given type or stores default as the type

    Gets a reference of a given type or stores default as the type

    Attributes
    protected
    Definition Classes
    Getters
  68. def getRule(id: String): Option[IRule]

    gets a rule

    gets a rule

    Definition Classes
    RuleBuilder
  69. def getRuleRef(id: String): Option[IDeclarationRef]

    gets a reference to a rule

    gets a reference to a rule

    Definition Classes
    RuleBuilder
  70. def getStats(stats: Option[SimpleStatistics]): Option[List[IStatistic]]
    Attributes
    protected
    Definition Classes
    Statistics
  71. def getStats(path: String): Option[List[IStatistic]]
    Attributes
    protected
    Definition Classes
    Statistics
  72. def getStructure(id: String): Option[IStructure]

    gets a structure

    gets a structure

    Definition Classes
    StructureBuilder
  73. def getStructureRef(id: String): Option[IDeclarationRef]

    gets a reference to a structure

    gets a reference to a structure

    Definition Classes
    StructureBuilder
  74. def getTag(id: String): Option[ITag]

    gets a tag

    gets a tag

    Definition Classes
    TagBuilder
  75. def getTagRef(id: String): Option[ITagRef]

    gets a reference to a tag

    gets a reference to a tag

    Definition Classes
    TagBuilder
  76. def getTheory(id: String): Option[ITheory]

    gets a theory

    gets a theory

    Definition Classes
    TheoryBuilder
  77. def getTheoryRef(id: String): Option[IModuleRef]

    gets a reference to a theory

    gets a reference to a theory

    Definition Classes
    TheoryBuilder
  78. def getView(id: String): Option[IView]

    gets a theory

    gets a theory

    Definition Classes
    ViewBuilder
  79. def getViewRef(id: String): Option[IModuleRef]

    gets a reference to a view

    gets a reference to a view

    Definition Classes
    ViewBuilder
  80. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  81. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  82. def log(e: Error): Unit

    logs an error - always logged

    logs an error - always logged

    Attributes
    protected
    Definition Classes
    Logger
  83. def log(s: ⇒ String, subgroup: Option[String] = None): Unit

    logs a message with this logger's logprefix

    logs a message with this logger's logprefix

    Attributes
    protected
    Definition Classes
    Logger
  84. def logDebug(s: ⇒ String): Unit

    logs something for debugging the mathhub extensiion

    logs something for debugging the mathhub extensiion

    Attributes
    protected
    Definition Classes
    Builder
  85. def logError(s: ⇒ String): Unit

    log as an error message

    log as an error message

    Attributes
    protected
    Definition Classes
    Logger
  86. def logGroup[A](a: ⇒ A): A

    wraps around a group to create nested logging

    wraps around a group to create nested logging

    Attributes
    protected
    Definition Classes
    Logger
  87. def logPrefix: String
    Definition Classes
    MathHubAPIContextLogger
  88. def logTemp(s: ⇒ String): Unit

    temporary logging - always logged

    temporary logging - always logged

    Attributes
    protected
    Definition Classes
    Logger
  89. def makeModuleReference(path: MPath): Option[IModuleRef]
    Definition Classes
    ModuleWrap
  90. def mathHub: MathHub
    Attributes
    protected
    Definition Classes
    Builder
  91. def memoizeObject(id: String)(fill: ⇒ Option[IReferencable]): Option[IReferencable]
    Attributes
    protected
    Definition Classes
    Cache
  92. def memoizeReference(id: String)(fill: ⇒ Option[IReference]): Option[IReference]
    Attributes
    protected
    Definition Classes
    Cache
  93. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  94. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  95. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  96. def onAdd(c: StructuralElement): Unit

    called after adding the element

    called after adding the element

    Definition Classes
    Cache
  97. def onArchiveClose(a: Archive): Unit

    called when an archive is removed

    called when an archive is removed

    Definition Classes
    Cache
  98. def onArchiveOpen(a: Archive): Unit

    called when a new archive is added

    called when a new archive is added

    Definition Classes
    Cache
  99. def onClear(): Unit

    called after clearing the Constant

    called after clearing the Constant

    Definition Classes
    Cache
  100. def onDelete(old: StructuralElement): Unit

    called after deleting the element

    called after deleting the element

    old

    the now-deleted element

    Definition Classes
    Cache
  101. def pseudoOpaqueElement(parent: IDocumentRef, parentPath: DPath, text: String): IOpaqueElement

    builds a pseudo opqaue-element with the given content

    builds a pseudo opqaue-element with the given content

    Attributes
    protected
    Definition Classes
    OpaqueBuilder
  102. val report: Report
    Definition Classes
    MathHubAPIContextLogger
  103. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  104. def toString(): String
    Definition Classes
    AnyRef → Any
  105. def transaction[T](name: String, t: (MathHubAPIContext) ⇒ T): T

    runs a transaction that blocks clearing the cache

    runs a transaction that blocks clearing the cache

    Definition Classes
    Cache
  106. def tryArchive(id: String): Option[LMHHubArchiveEntry]

    tries to find an archive with a given id

    tries to find an archive with a given id

    Attributes
    protected
    Definition Classes
    ArchiveBuilder
  107. def tryGroup(id: String): Option[LMHHubGroupEntry]

    tries to find a group with the given id

    tries to find a group with the given id

    Attributes
    protected
    Definition Classes
    GroupBuilder
  108. def tryTag(id: String): Option[String]

    tries to find a group with the given id

    tries to find a group with the given id

    Attributes
    protected
    Definition Classes
    TagBuilder
  109. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  110. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  111. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Builder

Inherited from NestedModuleBuilder

Inherited from RuleBuilder

Inherited from ConstantBuilder

Inherited from StructureBuilder

Inherited from DeclarationWrap

Inherited from ViewBuilder

Inherited from TheoryBuilder

Inherited from ModuleWrap

Inherited from OpaqueBuilder

Inherited from DocumentBuilder

Inherited from ArchiveBuilder

Inherited from TagBuilder

Inherited from GroupBuilder

Inherited from GroupsBuilder

Inherited from Statistics

Inherited from Getters

Inherited from Cache

Inherited from Logger

Inherited from AnyRef

Inherited from Any

Ungrouped