class MathHubAPIContext extends Logger with Builder
- Alphabetic
- By Inheritance
- MathHubAPIContext
- Builder
- NestedModuleBuilder
- RuleBuilder
- ConstantBuilder
- StructureBuilder
- DeclarationWrap
- ViewBuilder
- TheoryBuilder
- ModuleWrap
- OpaqueBuilder
- DocumentBuilder
- ArchiveBuilder
- TagBuilder
- GroupBuilder
- GroupsBuilder
- Statistics
- Getters
- Cache
- Logger
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new MathHubAPIContext(controller: Controller, report: Report)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
buildArchive(entry: LMHHubArchiveEntry): Option[IArchive]
builds an archive object
builds an archive object
- Attributes
- protected
- Definition Classes
- ArchiveBuilder
-
def
buildArchiveReference(entry: LMHHubArchiveEntry): Option[IArchiveRef]
builds a reference to an archive
builds a reference to an archive
- Attributes
- protected
- Definition Classes
- ArchiveBuilder
-
def
buildConstant(constant: Constant): Option[IConstant]
builds a constant representation
builds a constant representation
- Attributes
- protected
- Definition Classes
- ConstantBuilder
-
def
buildConstantReference(constant: Constant): Option[IDeclarationRef]
builds a reference to a constant
builds a reference to a constant
- Attributes
- protected
- Definition Classes
- ConstantBuilder
-
def
buildDocument(document: Document): Option[IDocument]
builds a document representation
builds a document representation
- Attributes
- protected
- Definition Classes
- DocumentBuilder
-
def
buildDocumentReference(document: Document): Option[IDocumentRef]
builds a reference to a document
builds a reference to a document
- Attributes
- protected
- Definition Classes
- DocumentBuilder
-
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
-
def
buildGroup(entry: LMHHubGroupEntry): Option[IGroup]
builds a group representation
builds a group representation
- Attributes
- protected
- Definition Classes
- GroupBuilder
-
def
buildGroupReference(entry: LMHHubGroupEntry): Option[IGroupRef]
builds a reference to a group
builds a reference to a group
- Attributes
- protected
- Definition Classes
- GroupBuilder
-
def
buildNestedModule(nested: NestedModule): Option[INestedModule]
builds a rule representation
builds a rule representation
- Attributes
- protected
- Definition Classes
- NestedModuleBuilder
-
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
-
def
buildOpaque(opaque: OpaqueElement): Option[IOpaqueElement]
builds an opaque representation
builds an opaque representation
- Attributes
- protected
- Definition Classes
- OpaqueBuilder
-
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
-
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
-
def
buildRule(rule: RuleConstant): Option[IRule]
builds a rule representation
builds a rule representation
- Attributes
- protected
- Definition Classes
- RuleBuilder
-
def
buildRuleReference(rule: RuleConstant): Option[IDeclarationRef]
builds a reference to a rule
builds a reference to a rule
- Attributes
- protected
- Definition Classes
- RuleBuilder
-
def
buildStructure(structure: Structure): Option[IStructure]
builds a structure representation
builds a structure representation
- Attributes
- protected
- Definition Classes
- StructureBuilder
-
def
buildStructureReference(structure: Structure): Option[IDeclarationRef]
builds a reference to a structure
builds a reference to a structure
- Attributes
- protected
- Definition Classes
- StructureBuilder
-
def
buildTag(tag: String): Option[ITag]
builds a tag
builds a tag
- Attributes
- protected
- Definition Classes
- TagBuilder
-
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
-
def
buildTheory(theory: Theory): Option[ITheory]
builds a theory representation
builds a theory representation
- Attributes
- protected
- Definition Classes
- TheoryBuilder
-
def
buildTheoryReference(theory: Theory): Option[IModuleRef]
builds a reference to a theory
builds a reference to a theory
- Attributes
- protected
- Definition Classes
- TheoryBuilder
-
def
buildView(view: View): Option[IView]
builds a view representation
builds a view representation
- Attributes
- protected
- Definition Classes
- ViewBuilder
-
def
buildViewReference(view: View): Option[IModuleRef]
builds a reference to a view
builds a reference to a view
- Attributes
- protected
- Definition Classes
- ViewBuilder
-
def
clearCache(): Unit
removes all items from the cache
removes all items from the cache
- Definition Classes
- Cache
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
val
controller: Controller
- Definition Classes
- MathHubAPIContext → Builder
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
getArchive(id: String): Option[IArchive]
gets an archive
gets an archive
- Definition Classes
- ArchiveBuilder
-
def
getArchiveRef(id: String): Option[IArchiveRef]
gets a reference to an archive
gets a reference to an archive
- Definition Classes
- ArchiveBuilder
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getComponents(declaration: Declaration): List[IComponent]
gets a list of components
gets a list of components
- Attributes
- protected
- Definition Classes
- DeclarationWrap
-
def
getConstant(id: String): Option[IConstant]
gets a structure
gets a structure
- Definition Classes
- ConstantBuilder
-
def
getConstantRef(id: String): Option[IDeclarationRef]
gets a reference to a constant
gets a reference to a constant
- Definition Classes
- ConstantBuilder
-
def
getDeclaration(id: String): Option[IDeclaration]
gets a module
gets a module
- Definition Classes
- DeclarationWrap
-
def
getDeclarationRef(id: String): Option[IDeclarationRef]
gets a reference to a module
gets a reference to a module
- Definition Classes
- DeclarationWrap
-
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
-
def
getDocument(id: String): Option[IDocument]
gets a document
gets a document
- Definition Classes
- DocumentBuilder
-
def
getDocumentRef(id: String): Option[IDocumentRef]
gets a reference to a document
gets a reference to a document
- Definition Classes
- DocumentBuilder
-
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
-
def
getGroup(id: String): Option[IGroup]
gets a group
gets a group
- Definition Classes
- GroupBuilder
-
def
getGroupRef(id: String): Option[IGroupRef]
gets a reference to a group
gets a reference to a group
- Definition Classes
- GroupBuilder
-
def
getGroups(): List[IGroupRef]
- Definition Classes
- GroupsBuilder
-
def
getHubObject(id: String): Option[IReferencable]
gets a hub object (i.e.
gets a hub object (i.e. archive, tag, group)
- Definition Classes
- Builder
-
def
getHubReference(id: String): Option[IReference]
gets a reference to a hub element
gets a reference to a hub element
- Definition Classes
- Builder
-
def
getLibraryObject(path: Path, id: String): Option[IReferencable]
gets an object from the library
gets an object from the library
- Definition Classes
- Builder
-
def
getLibraryReference(path: Path): Option[IReference]
- Definition Classes
- Builder
-
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
-
def
getModule(id: String): Option[IModule]
gets a module
gets a module
- Definition Classes
- ModuleWrap
-
def
getModuleRef(id: String): Option[IModuleRef]
gets a reference to a module
gets a reference to a module
- Definition Classes
- ModuleWrap
-
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
-
def
getNestedModule(id: String): Option[INestedModule]
gets a nested module
gets a nested module
- Definition Classes
- NestedModuleBuilder
-
def
getNestedModuleRef(id: String): Option[IDeclarationRef]
gets a reference to a nested module
gets a reference to a nested module
- Definition Classes
- NestedModuleBuilder
-
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
-
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
-
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
-
def
getOpaqueElement(id: String): Option[IOpaqueElement]
gets an opaque element
gets an opaque element
- Definition Classes
- OpaqueBuilder
-
def
getOpaqueElementRef(id: String): Option[IOpaqueElementRef]
gets a reference to an opaque element
gets a reference to an opaque element
- Definition Classes
- OpaqueBuilder
-
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
-
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
-
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
-
def
getRule(id: String): Option[IRule]
gets a rule
gets a rule
- Definition Classes
- RuleBuilder
-
def
getRuleRef(id: String): Option[IDeclarationRef]
gets a reference to a rule
gets a reference to a rule
- Definition Classes
- RuleBuilder
-
def
getStats(stats: Option[SimpleStatistics]): Option[List[IStatistic]]
- Attributes
- protected
- Definition Classes
- Statistics
-
def
getStats(path: String): Option[List[IStatistic]]
- Attributes
- protected
- Definition Classes
- Statistics
-
def
getStructure(id: String): Option[IStructure]
gets a structure
gets a structure
- Definition Classes
- StructureBuilder
-
def
getStructureRef(id: String): Option[IDeclarationRef]
gets a reference to a structure
gets a reference to a structure
- Definition Classes
- StructureBuilder
-
def
getTag(id: String): Option[ITag]
gets a tag
gets a tag
- Definition Classes
- TagBuilder
-
def
getTagRef(id: String): Option[ITagRef]
gets a reference to a tag
gets a reference to a tag
- Definition Classes
- TagBuilder
-
def
getTheory(id: String): Option[ITheory]
gets a theory
gets a theory
- Definition Classes
- TheoryBuilder
-
def
getTheoryRef(id: String): Option[IModuleRef]
gets a reference to a theory
gets a reference to a theory
- Definition Classes
- TheoryBuilder
-
def
getView(id: String): Option[IView]
gets a theory
gets a theory
- Definition Classes
- ViewBuilder
-
def
getViewRef(id: String): Option[IModuleRef]
gets a reference to a view
gets a reference to a view
- Definition Classes
- ViewBuilder
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
log(e: Error): Unit
logs an error - always logged
logs an error - always logged
- Attributes
- protected
- Definition Classes
- Logger
-
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
-
def
logDebug(s: ⇒ String): Unit
logs something for debugging the mathhub extensiion
logs something for debugging the mathhub extensiion
- Attributes
- protected
- Definition Classes
- Builder
-
def
logError(s: ⇒ String): Unit
log as an error message
log as an error message
- Attributes
- protected
- Definition Classes
- Logger
-
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
-
def
logPrefix: String
- Definition Classes
- MathHubAPIContext → Logger
-
def
logTemp(s: ⇒ String): Unit
temporary logging - always logged
temporary logging - always logged
- Attributes
- protected
- Definition Classes
- Logger
-
def
makeModuleReference(path: MPath): Option[IModuleRef]
- Definition Classes
- ModuleWrap
-
def
mathHub: MathHub
- Attributes
- protected
- Definition Classes
- Builder
-
def
memoizeObject(id: String)(fill: ⇒ Option[IReferencable]): Option[IReferencable]
- Attributes
- protected
- Definition Classes
- Cache
-
def
memoizeReference(id: String)(fill: ⇒ Option[IReference]): Option[IReference]
- Attributes
- protected
- Definition Classes
- Cache
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
onAdd(c: StructuralElement): Unit
called after adding the element
called after adding the element
- Definition Classes
- Cache
-
def
onArchiveClose(a: Archive): Unit
called when an archive is removed
called when an archive is removed
- Definition Classes
- Cache
-
def
onArchiveOpen(a: Archive): Unit
called when a new archive is added
called when a new archive is added
- Definition Classes
- Cache
-
def
onClear(): Unit
called after clearing the Constant
called after clearing the Constant
- Definition Classes
- Cache
-
def
onDelete(old: StructuralElement): Unit
called after deleting the element
-
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
-
val
report: Report
- Definition Classes
- MathHubAPIContext → Logger
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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
-
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
-
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
-
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
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()