class Archive extends ROArchive with Validate with ScalaCode with ZipArchive
archive management
Archive is a very big class, so most of its functionality is outsourced to various traits that are mixed in here
- Source
- Archive.scala
- Alphabetic
- By Inheritance
- Archive
- ZipArchive
- ScalaCode
- Validate
- ROArchive
- Logger
- Storage
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
/(dim: ArchiveDimension): File
the absolute path to a given dimension
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
MMTPathToContentPath(m: MPath): File
Get the disk path of the module in the content folder
Get the disk path of the module in the content folder
- m
the MPath of the module
- returns
the File descriptor of the destination file in the content folder
- val archString: String
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
check(in: FilePath = EmptyPath, controller: Controller): Unit
checks modules in content structurally and generates term-level dependency relation in .occ files
checks modules in content structurally and generates term-level dependency relation in .occ files
- Definition Classes
- Validate
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
val
custom: ArchiveCustomization
- Attributes
- protected
-
def
deleteFile(f: File): Unit
- Attributes
- protected
-
def
dependencies: List[String]
gets the direct dependencies of an archive
-
def
destroy: Unit
called to release all held resources, override as needed
called to release all held resources, override as needed
- Definition Classes
- Storage
-
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] )
- val foundation: Option[MPath]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getSuffix(base: URI, uri: URI): List[String]
- Attributes
- protected
- Definition Classes
- Storage
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val id: String
- def includeDir(n: String): Boolean
-
def
integrateScala(controller: Controller, in: FilePath = EmptyPath): Unit
Integrate scala into a dimension
Integrate scala into a dimension
- Definition Classes
- ScalaCode
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
load(p: Path)(implicit controller: Controller): Unit
dereferences a path and adds the content to the controller or throws NotApplicable e.g., by sending an XML document to the XML reader
-
def
loadFragment(neededPath: Path, existingPath: Path)(implicit controller: Controller): Unit
dereferences a path to a fragment of an already loaded StructuralElement and adds only that fragment empty by default, storages that can retrieve individual fragments should override this
dereferences a path to a fragment of an already loaded StructuralElement and adds only that fragment empty by default, storages that can retrieve individual fragments should override this
- Definition Classes
- Storage
-
def
loadJava(controller: Controller, cls: String): Unit
- Definition Classes
- ScalaCode
-
def
loadXML(u: URI, dpath: DPath, reader: BufferedReader)(implicit controller: Controller): Unit
implementing classes should call this to load an OMDoc XML stream (which this method will close afterwards)
implementing classes should call this to load an OMDoc XML stream (which this method will close afterwards)
- Attributes
- protected
- Definition Classes
- Storage
-
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
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
- val logPrefix: String
-
def
logTemp(s: ⇒ String): Unit
temporary logging - always logged
temporary logging - always logged
- Attributes
- protected
- Definition Classes
- Logger
- val namespaceMap: NamespaceMap
- val narrationBackend: ArchiveNarrationStorage
- val narrationBase: URI
-
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()
-
val
ns: Option[Path]
the NamespaceMap built from the ns and ns-prefix properties
- val properties: Map[String, String]
- def readRelational(in: FilePath, controller: Controller, kd: String): Unit
- val report: Report
-
def
resolveDimension(dim: ArchiveDimension): FilePath
the relative path in the archive of a give dimension
- val root: File
- val rootString: String
-
def
stats(implicit controller: Controller): SimpleStatistics
Returns (#Theories,#Constants)*
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toMar(target: File = root / (root.getName + ".mar")): Unit
pack everything in a mar zip archive.
pack everything in a mar zip archive.
- target
the target mar file. Default is <name>.mar in the root folder, where <name> is the name of the root
- Definition Classes
- ZipArchive
-
def
toString(): String
- Definition Classes
- ROArchive → AnyRef → Any
-
def
transitiveDependencies(backend: Backend): List[Archive]
returns the list of loaded transitive dependencies of this archive, including itself
-
def
traverse[A](dim: ArchiveDimension, in: FilePath, mode: TraverseMode, sendLog: Boolean = true, forClean: Boolean = false)(onFile: (Current) ⇒ A, onDir: (Current, List[A]) ⇒ A = (_: Current, _: List[A]) => ()): Option[A]
traverses a dimension calling continuations on files and subdirectories
-
def
validate(in: FilePath = EmptyPath, controller: Controller): Unit
checks modules in content structurally and then validates all objects
checks modules in content structurally and then validates all objects
- Definition Classes
- Validate
-
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()
Deprecated Value Members
-
lazy val
allContent: List[MPath]
Kinda hacky; can be used to get all Modules residing in this archive somewhat quickly
Kinda hacky; can be used to get all Modules residing in this archive somewhat quickly
- Annotations
- @deprecated
- Deprecated
(Since version ) inefficient and brittle; use getModules for this