de.unirostock.sems.docompiler

Class Compiler

java.lang.Object

de.unirostock.sems.docompiler.Compiler

public class Compiler
extends Object

Compiler for Document Objects. This compiler takes a Research Object and compiles it into a PDF document.

Author:

Martin Scharm

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DIE Should the main die in case of an error? Otherwise the main will just return.
static String	ROOT_DOC_ANNOTAION The ROOT_DOC_ANNOTAION, used to identify the root document.

Constructor Summary

Constructors

Constructor and Description
Compiler()

Method Summary

Modifier and Type	Method and Description
static boolean	compileLatex(Path sourceDirectory, String texFile, Path logFile) Compile the latex project to a pdf file.
static void	die(String message) Die.
static String	extractResearchObject(org.apache.taverna.robundle.Bundle bundle, Path targetDir) Extract the files of a research object to a directory on the disk.
static void	main(String[] args) The main method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DIE

public static boolean DIE

Should the main die in case of an error? Otherwise the main will just return.

ROOT_DOC_ANNOTAION

public static final String ROOT_DOC_ANNOTAION

The ROOT_DOC_ANNOTAION, used to identify the root document.

See Also:

Constant Field Values

Constructor Detail

Compiler

public Compiler()

Method Detail

die

public static final void die(String message)

Die. Stop the execution delivering a last message.

Parameters:

message - the last message

extractResearchObject

public static final String extractResearchObject(org.apache.taverna.robundle.Bundle bundle,
                                                 Path targetDir)
                                          throws IOException

Extract the files of a research object to a directory on the disk.

Parameters:

bundle - the research object

targetDir - the directory to write to

Returns:

the path to the root latex file in the document

Throws:

IOException - the IO exception

compileLatex

public static final boolean compileLatex(Path sourceDirectory,
                                         String texFile,
                                         Path logFile)
                                  throws IOException,
                                         InterruptedException

Compile the latex project to a pdf file.

Parameters:

sourceDirectory - the directory containing the latex project

texFile - the main latex file

logFile - the log file

Returns:

true, if compile latex

Throws:

IOException - the IO exception

InterruptedException - the interrupted exception

main

public static void main(String[] args)
                 throws IOException,
                        InterruptedException

The main method.

Parameters:

args - the arguments: |args| = 1 && args[0] must be a file

Throws:

IOException - the IO exception

InterruptedException - the interrupted exception