Packages

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
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Archive
  2. ZipArchive
  3. ScalaCode
  4. Validate
  5. ROArchive
  6. Logger
  7. Storage
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Archive(root: File, properties: Map[String, String], report: Report)

    root

    the root folder that contains the source folder

    properties

    a key value map

    report

    the reporting mechanism

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def /(dim: ArchiveDimension): File

    the absolute path to a given dimension

  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. 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

  6. val archString: String
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. 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
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  10. val custom: ArchiveCustomization
    Attributes
    protected
  11. def deleteFile(f: File): Unit
    Attributes
    protected
  12. def dependencies: List[String]

    gets the direct dependencies of an archive

  13. def destroy: Unit

    called to release all held resources, override as needed

    called to release all held resources, override as needed

    Definition Classes
    Storage
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. val foundation: Option[MPath]
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def getSuffix(base: URI, uri: URI): List[String]
    Attributes
    protected
    Definition Classes
    Storage
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. val id: String
  22. def includeDir(n: String): Boolean
  23. def integrateScala(controller: Controller, in: FilePath = EmptyPath): Unit

    Integrate scala into a dimension

    Integrate scala into a dimension

    Definition Classes
    ScalaCode
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. 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

    dereferences a path and adds the content to the controller or throws NotApplicable e.g., by sending an XML document to the XML reader

    a storage may add more/additional content than necessary, e.g., the containing file/theory or a dependency closure

    Definition Classes
    ArchiveStorage
  26. 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
  27. def loadJava(controller: Controller, cls: String): Unit
    Definition Classes
    ScalaCode
  28. 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
  29. def log(e: Error): Unit

    logs an error - always logged

    logs an error - always logged

    Attributes
    protected
    Definition Classes
    Logger
  30. 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
  31. def logError(s: ⇒ String): Unit

    log as an error message

    log as an error message

    Attributes
    protected
    Definition Classes
    Logger
  32. 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
  33. val logPrefix: String
    Definition Classes
    ROArchiveLogger
  34. def logTemp(s: ⇒ String): Unit

    temporary logging - always logged

    temporary logging - always logged

    Attributes
    protected
    Definition Classes
    Logger
  35. val namespaceMap: NamespaceMap
  36. val narrationBackend: ArchiveNarrationStorage
  37. val narrationBase: URI
  38. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  40. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  41. val ns: Option[Path]

    the NamespaceMap built from the ns and ns-prefix properties

  42. val properties: Map[String, String]
    Definition Classes
    ArchiveROArchive
  43. def readRelational(in: FilePath, controller: Controller, kd: String): Unit
  44. val report: Report
    Definition Classes
    ArchiveROArchiveLogger
  45. def resolveDimension(dim: ArchiveDimension): FilePath

    the relative path in the archive of a give dimension

  46. val root: File
  47. val rootString: String
    Definition Classes
    ArchiveROArchive
  48. def stats(implicit controller: Controller): SimpleStatistics

    Returns (#Theories,#Constants)*

  49. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  50. 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
  51. def toString(): String
    Definition Classes
    ROArchive → AnyRef → Any
  52. def transitiveDependencies(backend: Backend): List[Archive]

    returns the list of loaded transitive dependencies of this archive, including itself

  53. 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

  54. 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
  55. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Deprecated Value Members

  1. 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

Inherited from ZipArchive

Inherited from ScalaCode

Inherited from Validate

Inherited from ROArchive

Inherited from Logger

Inherited from Storage

Inherited from AnyRef

Inherited from Any

Ungrouped