abstract class RelationGraphExporter extends BuildTarget with StructurePresenter
builds a graph from relational and then calls dot to produce an svg file
- Alphabetic
- By Inheritance
- RelationGraphExporter
- StructurePresenter
- Exporter
- BuildTarget
- FormatBasedExtension
- Extension
- Logger
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new RelationGraphExporter()
Type Members
-
case class
LocalError(s: String) extends ExtensionError with Product with Serializable
a custom error class for this extension
a custom error class for this extension
- Definition Classes
- Extension
Abstract Value Members
-
abstract
def
buildGraph(se: StructuralElement): DotGraph
build the abstract graph to be visualized
-
abstract
def
description: String
a short descriptive name to be used in labels, menus, etc.
-
abstract
def
key: String
a string identifying this build target, used for parsing commands, logging, error messages
a string identifying this build target, used for parsing commands, logging, error messages
- Definition Classes
- BuildTarget
Concrete 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
-
val
_rh: RenderingHandler
must be set by deriving classes to direct output, not necessary if outputTo is used
must be set by deriving classes to direct output, not necessary if outputTo is used
- Attributes
- protected
- Definition Classes
- Exporter
-
def
apply(se: StructuralElement, standalone: Boolean = false)(implicit rh: RenderingHandler): Unit
contains at least all elements of the document
contains at least all elements of the document
- standalone
if true, include appropriate header and footer
- rh
output stream
- Definition Classes
- RelationGraphExporter → StructurePresenter
-
def
apply(modifier: BuildTargetModifier, arch: Archive, in: FilePath): Unit
the main function to run the build target
the main function to run the build target
en empty in filepath addresses the whole archive
- modifier
chooses build, clean, or update
- arch
the archive to build on
- in
the folder inside the archive's inDim folder to which building is restricted
- Definition Classes
- BuildTarget
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
asString(e: StructuralElement): String
- Definition Classes
- StructurePresenter
-
def
build(a: Archive, up: Update, in: FilePath): Unit
build or update this target in a given archive
build or update this target in a given archive
- Definition Classes
- Exporter → BuildTarget
-
def
buildDepsFirst(a: Archive, up: Update, in: FilePath = EmptyPath): Unit
build estimated dependencies first
build estimated dependencies first
this can be used by the trivial build manager to build targets (like latexml) in dependency order provided that estimated dependencies are correct.
For a queue build manager this code is obsolete
- Definition Classes
- BuildTarget
-
def
canHandle(p: Path): Boolean
override this method if your exporter cannot export arbitrary content
override this method if your exporter cannot export arbitrary content
- p
the MMT URI of a content element to be exported
- Definition Classes
- Exporter
-
def
catchErrors[A](msg: String, recoverWith: ⇒ A)(code: ⇒ A): A
like its partner but with return value
like its partner but with return value
- Attributes
- protected
- Definition Classes
- Extension
-
def
catchErrors(msg: String)(code: ⇒ Unit): Unit
convenience method for wrapping code in error handler that throws LocalError
convenience method for wrapping code in error handler that throws LocalError
- Attributes
- protected
- Definition Classes
- Extension
-
def
clean(a: Archive, in: FilePath): Unit
clean this target in a given archive
clean this target in a given archive
- Definition Classes
- Exporter → BuildTarget
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
val
controller: Controller
the controller that this extension is added to; only valid after creation of the extension, i.e., will return null if used in a non-lazy val-field
the controller that this extension is added to; only valid after creation of the extension, i.e., will return null if used in a non-lazy val-field
- Attributes
- protected
- Definition Classes
- Extension
-
lazy val
defaultPrefix: String
- Definition Classes
- Extension
-
def
delete(f: File): Unit
auxiliary method for deleting a file
auxiliary method for deleting a file
- Attributes
- protected
- Definition Classes
- BuildTarget
-
def
destroy: Unit
extension-specific cleanup (override as needed, empty by default)
extension-specific cleanup (override as needed, empty by default)
Extensions may create persistent data structures and threads, but they must clean up after themselves in this method
- Definition Classes
- Extension
-
def
destroyWhenRemainingTasksFinished: Unit
convenience for calling waitUntilRemainingTasksFinished and then destroy
convenience for calling waitUntilRemainingTasksFinished and then destroy
- Definition Classes
- Extension
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
exportDerivedModule(dm: DerivedModule, bf: BuildTask): Unit
applied to each derived module, does nothing by default
applied to each derived module, does nothing by default
- Definition Classes
- StructurePresenter → Exporter
-
def
exportDocument(doc: Document, bf: BuildTask): Unit
applied to each document (i.e., narration-folders and .omdoc files)
applied to each document (i.e., narration-folders and .omdoc files)
- Definition Classes
- StructurePresenter → Exporter
-
def
exportNamespace(dpath: DPath, bd: BuildTask, namespaces: List[BuildTask], modules: List[BuildTask]): Unit
does nothing
does nothing
- dpath
the namespace
- namespaces
the sub-namespace in this namespace
- modules
the modules in this namespace
- Definition Classes
- StructurePresenter → Exporter
-
def
exportTheory(thy: Theory, bf: BuildTask): Unit
applied to each theory
applied to each theory
- Definition Classes
- StructurePresenter → Exporter
-
def
exportView(view: View, bf: BuildTask): Unit
applied to each view
applied to each view
- Definition Classes
- StructurePresenter → Exporter
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
folderName: String
the file name for files representing folders, defaults to "", override as needed
the file name for files representing folders, defaults to "", override as needed
- Attributes
- protected
- Definition Classes
- Exporter
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getFromFirstArgOrEnvvar(args: List[String], name: String, default: String = ""): String
- Attributes
- protected
- Definition Classes
- Extension
-
def
getOutFileForModule(p: MPath): Option[File]
returns the output file that this exporter uses for some module
returns the output file that this exporter uses for some module
- Attributes
- protected
- Definition Classes
- Exporter
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
init(controller: Controller): Unit
MMT initialization (idempotent)
-
def
initOther(e: Extension): Unit
any extension can initialize other extensions if those are not meant to be added to the ExtensionManager
any extension can initialize other extensions if those are not meant to be added to the ExtensionManager
- Attributes
- protected
- Definition Classes
- Extension
-
def
isApplicable(format: String): Boolean
- format
the format/key/other identifier, for which an extension is needed
- returns
true if this extension is applicable
- Definition Classes
- BuildTarget → FormatBasedExtension
-
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
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
defaults to the key
defaults to the key
- Definition Classes
- BuildTarget → Extension → Logger
-
def
logTemp(s: ⇒ String): Unit
temporary logging - always logged
temporary logging - always logged
- Attributes
- protected
- Definition Classes
- Logger
-
def
makeErrorThrower(msg: String): ErrorHandler
an ErrorHandler that wraps an error in a LocalError and throws it
an ErrorHandler that wraps an error in a LocalError and throws it
- Attributes
- protected
- Definition Classes
- Extension
-
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
outDim: Dim
the dimension for storing generated files, defaults to export/key, override as needed
the dimension for storing generated files, defaults to export/key, override as needed
- Attributes
- protected
- Definition Classes
- Exporter
-
def
outExt: String
the file extension used for generated files, defaults to key, override as needed
the file extension used for generated files, defaults to key, override as needed
- Definition Classes
- RelationGraphExporter → Exporter
-
def
outputTo(out: File)(body: ⇒ Unit): Unit
sends output to a certain file, file is created new and deleted if empty afterwards
sends output to a certain file, file is created new and deleted if empty afterwards
- out
the output file to be used while executing body
- body
any code that produces output
- Attributes
- protected
- Definition Classes
- Exporter
-
def
producesFrom(out: FilePath): Option[FilePath]
- Definition Classes
- Exporter
- val report: Report
-
def
rh: RenderingHandler
gives access to the RenderingHandler for sending output
gives access to the RenderingHandler for sending output
- Attributes
- protected
- Definition Classes
- Exporter
-
def
start(args: List[String]): Unit
expects one argument: the path to graphviz; alternatively set variable GraphViz
expects one argument: the path to graphviz; alternatively set variable GraphViz
- Definition Classes
- RelationGraphExporter → Exporter → Extension
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- RelationGraphExporter → BuildTarget → AnyRef → Any
-
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()
-
def
waitUntilRemainingTasksFinished: Unit
extensions that process tasks in separate threads should override this and wait until those threads are done
extensions that process tasks in separate threads should override this and wait until those threads are done
- Definition Classes
- Extension
Deprecated Value Members
-
def
asJSON(ls: List[StructuralElement]): JSONObject
- Annotations
- @MMT_TODO( message = "" )
- Deprecated
-
def
asJSON(se: StructuralElement): JSONObject
- Annotations
- @MMT_TODO( message = "" )
- Deprecated