com.simiacryptus.util.io

Class MarkdownNotebookOutput

java.lang.Object

com.simiacryptus.util.io.MarkdownNotebookOutput

All Implemented Interfaces:

NotebookOutput, Closeable, AutoCloseable

public class MarkdownNotebookOutput
extends Object
implements NotebookOutput

The type Markdown notebook output.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_OUTPUT The constant MAX_OUTPUT.
List<CharSequence>	toc The Toc.

Constructor Summary

Constructors

Constructor and Description
MarkdownNotebookOutput(File reportFile, String name, boolean autobrowse) Instantiates a new Markdown notebook output.
MarkdownNotebookOutput(File reportFile, String name, int httpPort, boolean autobrowse) Instantiates a new Markdown notebook output.

Method Summary

Modifier and Type	Method and Description
CharSequence	anchor(CharSequence anchorId) Anchor string.
CharSequence	anchorId() Anchor id string.
void	close()
<T> T	code(UncheckedSupplier<T> fn, int maxLog, int framesNo) Code t.
CharSequence	file(byte[] data, CharSequence filename, CharSequence caption) File string.
OutputStream	file(CharSequence name) File output stream.
String	file(CharSequence data, CharSequence caption) File string.
String	file(CharSequence data, CharSequence fileName, CharSequence caption) File string.
String	format(CharSequence fmt, Object... args) Format string.
static MarkdownNotebookOutput	get(boolean autobrowse) Get markdown notebook output.
static MarkdownNotebookOutput	get(Object source, boolean autobrowse) Get markdown notebook output.
static CharSequence	getExceptionString(Throwable e) Gets exception string.
CharSequence	getFrontMatterProperty(CharSequence key) Gets front matter property.
FileNanoHTTPD	getHttpd() Gets httpd.
int	getMaxImageSize()
int	getMaxOutSize() Gets max out size.
CharSequence	getName() Gets name.
File	getResourceDir() Gets resource dir.
File	getRoot() Gets root.
void	h1(CharSequence fmt, Object... args) H 1.
void	h2(CharSequence fmt, Object... args) H 2.
void	h3(CharSequence fmt, Object... args) H 3.
String	image(BufferedImage rawImage, CharSequence caption) Image string.
boolean	isAutobrowse()
CharSequence	link(File file, CharSequence text) Link string.
MarkdownNotebookOutput	onComplete(java.util.function.Consumer<File>... tasks) On complete markdown notebook output.
void	out(String fmt, Object... args) Out.
void	p(CharSequence fmt, Object... args) P.
static Path	pathToCodeFile(File baseFile, File file) Path to code file path.
CharSequence	pathToGitResource(File file)
CharSequence	pathToReportResource(File file) Code file string.
void	setFrontMatterProperty(CharSequence key, CharSequence value) Sets fm prop.
MarkdownNotebookOutput	setMaxImageSize(int maxImageSize)
String	summarize(String logSrc, int maxLog) Summarize string.
String	testName() Test name string.
String	toString(List<CharSequence> list) To string string.
static java.util.function.Consumer<NotebookOutput>	wrapFrontmatter(java.util.function.Consumer<NotebookOutput> fn) Wrap frontmatter consumer.
void	writeArchive(File root, File dir, ZipOutputStream out, java.util.function.Predicate<? super File> filter) Write archive.
void	writeHtmlAndPdf(File root, String baseName) Write html and pdf.
void	writeMarkdownWithFrontmatter(PrintWriter out) Write markdown with frontmatter.
void	writeZip(File root, String baseName) Write zip.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.simiacryptus.util.io.NotebookOutput

appendFrontMatterProperty, code, code, concat, out

Field Detail

MAX_OUTPUT

public static int MAX_OUTPUT

The constant MAX_OUTPUT.

toc

@Nonnull
public List<CharSequence> toc

The Toc.

Constructor Detail

MarkdownNotebookOutput

public MarkdownNotebookOutput(@Nonnull
                              File reportFile,
                              String name,
                              boolean autobrowse)
                       throws FileNotFoundException

Instantiates a new Markdown notebook output.

Parameters:

reportFile - the file name

name - the name

Throws:

FileNotFoundException - the file not found exception

MarkdownNotebookOutput

public MarkdownNotebookOutput(@Nonnull
                              File reportFile,
                              String name,
                              int httpPort,
                              boolean autobrowse)
                       throws FileNotFoundException

Instantiates a new Markdown notebook output.

Parameters:

reportFile - the file name

name - the name

httpPort - the http port

autobrowse -

Throws:

FileNotFoundException - the file not found exception

Method Detail

wrapFrontmatter

public static java.util.function.Consumer<NotebookOutput> wrapFrontmatter(@Nonnull
                                                                          java.util.function.Consumer<NotebookOutput> fn)

Wrap frontmatter consumer.

Parameters:

fn - the fn

Returns:

the consumer

get

public static MarkdownNotebookOutput get(boolean autobrowse)

Get markdown notebook output.

Parameters:

autobrowse -

Returns:

the markdown notebook output

get

public static MarkdownNotebookOutput get(Object source,
                                         boolean autobrowse)

Get markdown notebook output.

Parameters:

source - the source

autobrowse -

Returns:

the markdown notebook output

getExceptionString

@Nonnull
public static CharSequence getExceptionString(Throwable e)

Gets exception string.

Parameters:

e - the e

Returns:

the exception string

onComplete

@Nonnull
public MarkdownNotebookOutput onComplete(java.util.function.Consumer<File>... tasks)

On complete markdown notebook output.

Parameters:

tasks - the tasks

Returns:

the markdown notebook output

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getRoot

@Nonnull
public File getRoot()

Gets root.

Returns:

the root

testName

public String testName()

Test name string.

Returns:

the string

writeZip

public void writeZip(File root,
                     String baseName)
              throws IOException

Write zip.

Parameters:

root - the root

baseName - the base name

Throws:

IOException - the io exception

pathToCodeFile

public static Path pathToCodeFile(File baseFile,
                                  @Nonnull
                                  File file)
                           throws IOException

Path to code file path.

Parameters:

baseFile -

file - the file

Returns:

the path

Throws:

IOException - the io exception

toString

@Nonnull
public String toString(List<CharSequence> list)

To string string.

Parameters:

list - the list

Returns:

the string

writeArchive

public void writeArchive(File root,
                         File dir,
                         ZipOutputStream out,
                         java.util.function.Predicate<? super File> filter)

Write archive.

Parameters:

root - the root

dir - the dir

out - the out

filter - the filter

writeMarkdownWithFrontmatter

public void writeMarkdownWithFrontmatter(PrintWriter out)

Write markdown with frontmatter.

Parameters:

out - the out

setFrontMatterProperty

public void setFrontMatterProperty(CharSequence key,
                                   CharSequence value)

Description copied from interface: NotebookOutput

Sets fm prop.

Specified by:

setFrontMatterProperty in interface NotebookOutput

Parameters:

key - the key

value - the value

getFrontMatterProperty

public CharSequence getFrontMatterProperty(CharSequence key)

Description copied from interface: NotebookOutput

Gets front matter property.

Specified by:

getFrontMatterProperty in interface NotebookOutput

Parameters:

key - the key

Returns:

the front matter property

getName

public CharSequence getName()

Description copied from interface: NotebookOutput

Gets name.

Specified by:

getName in interface NotebookOutput

Returns:

the name

anchor

public CharSequence anchor(CharSequence anchorId)

Anchor string.

Parameters:

anchorId - the anchor id

Returns:

the string

anchorId

public CharSequence anchorId()

Anchor id string.

Returns:

the string

writeHtmlAndPdf

public void writeHtmlAndPdf(File root,
                            String baseName)
                     throws IOException

Write html and pdf.

Parameters:

root - the root

baseName - the base name

Throws:

IOException - the io exception

file

@Nonnull
public OutputStream file(@Nonnull
                                  CharSequence name)

Description copied from interface: NotebookOutput

File output stream.

Specified by:

file in interface NotebookOutput

Parameters:

name - the name

Returns:

the output stream

file

@Nonnull
public String file(CharSequence data,
                            CharSequence caption)

Description copied from interface: NotebookOutput

File string.

Specified by:

file in interface NotebookOutput

Parameters:

data - the data

caption - the caption

Returns:

the string

file

@Nonnull
public CharSequence file(@Nonnull
                                  byte[] data,
                                  @Nonnull
                                  CharSequence filename,
                                  CharSequence caption)

Description copied from interface: NotebookOutput

File string.

Specified by:

file in interface NotebookOutput

Parameters:

data - the data

filename - the filename

caption - the caption

Returns:

the string

file

@Nonnull
public String file(@Nullable
                            CharSequence data,
                            @Nonnull
                            CharSequence fileName,
                            CharSequence caption)

Description copied from interface: NotebookOutput

File string.

Specified by:

file in interface NotebookOutput

Parameters:

data - the data

fileName - the file name

caption - the caption

Returns:

the string

getResourceDir

@Nonnull
public File getResourceDir()

Gets resource dir.

Specified by:

getResourceDir in interface NotebookOutput

Returns:

the resource dir

h1

public void h1(@Nonnull
               CharSequence fmt,
               Object... args)

Description copied from interface: NotebookOutput

H 1.

Specified by:

h1 in interface NotebookOutput

Parameters:

fmt - the fmt

args - the args

h2

public void h2(@Nonnull
               CharSequence fmt,
               Object... args)

Description copied from interface: NotebookOutput

H 2.

Specified by:

h2 in interface NotebookOutput

Parameters:

fmt - the fmt

args - the args

h3

public void h3(@Nonnull
               CharSequence fmt,
               Object... args)

Description copied from interface: NotebookOutput

H 3.

Specified by:

h3 in interface NotebookOutput

Parameters:

fmt - the fmt

args - the args

image

@Nonnull
public String image(@Nullable
                             BufferedImage rawImage,
                             CharSequence caption)

Description copied from interface: NotebookOutput

Image string.

Specified by:

image in interface NotebookOutput

Parameters:

rawImage - the raw image

caption - the caption

Returns:

the string

code

public <T> T code(@Nonnull
                  UncheckedSupplier<T> fn,
                  int maxLog,
                  int framesNo)

Description copied from interface: NotebookOutput

Code t.

Specified by:

code in interface NotebookOutput

Type Parameters:

T - the type parameter

Parameters:

fn - the fn

maxLog - the max log

framesNo - the frames no

Returns:

the t

link

@Nonnull
public CharSequence link(@Nonnull
                                  File file,
                                  CharSequence text)

Description copied from interface: NotebookOutput

Link string.

Specified by:

link in interface NotebookOutput

Parameters:

file - the file

text - the text

Returns:

the string

pathToReportResource

public CharSequence pathToReportResource(@Nonnull
                                         File file)
                                  throws IOException

Code file string.

Parameters:

file - the file

Returns:

the string

Throws:

IOException - the io exception

pathToGitResource

public CharSequence pathToGitResource(@Nonnull
                                      File file)
                               throws IOException

Throws:

IOException

out

public void out(@Nonnull
                String fmt,
                Object... args)

Description copied from interface: NotebookOutput

Out.

Specified by:

out in interface NotebookOutput

Parameters:

fmt - the fmt

args - the args

format

@Nonnull
public String format(@Nonnull
                              CharSequence fmt,
                              @Nonnull
                              Object... args)

Format string.

Parameters:

fmt - the fmt

args - the args

Returns:

the string

p

public void p(CharSequence fmt,
              Object... args)

Description copied from interface: NotebookOutput

P.

Specified by:

p in interface NotebookOutput

Parameters:

fmt - the fmt

args - the args

summarize

@Nonnull
public String summarize(@Nonnull
                                 String logSrc,
                                 int maxLog)

Summarize string.

Parameters:

logSrc - the log src

maxLog - the max log

Returns:

the string

getMaxOutSize

public int getMaxOutSize()

Description copied from interface: NotebookOutput

Gets max out size.

Specified by:

getMaxOutSize in interface NotebookOutput

Returns:

the max out size

getHttpd

public FileNanoHTTPD getHttpd()

Description copied from interface: NotebookOutput

Gets httpd.

Specified by:

getHttpd in interface NotebookOutput

Returns:

the httpd

isAutobrowse

public boolean isAutobrowse()

getMaxImageSize

public int getMaxImageSize()

setMaxImageSize

public MarkdownNotebookOutput setMaxImageSize(int maxImageSize)