com.simiacryptus.notebook

Class MarkdownNotebookOutput

java.lang.Object

com.simiacryptus.notebook.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.
static Random	random The constant random.
List<CharSequence>	toc The Toc.

Constructor Summary

Constructors

Constructor and Description
MarkdownNotebookOutput(File reportFile) Instantiates a new Markdown notebook output.
MarkdownNotebookOutput(File reportFile, boolean autobrowse) Instantiates a new Markdown notebook output.
MarkdownNotebookOutput(File reportFile, 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	eval(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 NotebookOutput	get(File path, boolean autobrowse) Get markdown notebook output.
static NotebookOutput	get(String s) Get notebook output.
URI	getArchiveHome() Gets archive home.
URI	getCurrentHome() Gets current home.
static CharSequence	getExceptionString(Throwable e) Gets exception string.
CharSequence	getFrontMatterProperty(CharSequence key) Gets front matter property.
FileHTTPD	getHttpd() Gets httpd.
int	getMaxImageSize() Gets max image size.
int	getMaxOutSize() Gets max out size.
CharSequence	getName() Gets name.
File	getReportFile() Gets report file.
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.
boolean	isAutobrowse() Is autobrowse boolean.
String	jpg(BufferedImage rawImage, CharSequence caption) Jpg string.
File	jpgFile(BufferedImage rawImage, File file) Jpg file file.
CharSequence	link(File file, CharSequence text) Link string.
NotebookOutput	onComplete(Runnable... tasks) On complete markdown notebook output.
void	out(CharSequence fmt, Object... args) Out.
void	p(CharSequence fmt, Object... args) P.
CharSequence	pathTo(File file) Code file string.
String	png(BufferedImage rawImage, CharSequence caption) Image string.
File	pngFile(BufferedImage rawImage, File file) Png file file.
File	resolveResource(CharSequence name) Resolve resource file.
NotebookOutput	setArchiveHome(URI archiveHome) Sets archive home.
NotebookOutput	setAutobrowse(boolean autobrowse) Sets autobrowse.
NotebookOutput	setCurrentHome(URI currentHome) Sets current home.
void	setFrontMatterProperty(CharSequence key, CharSequence value) Sets fm prop.
NotebookOutput	setMaxImageSize(int maxImageSize) Sets max image size.
NotebookOutput	setName(String name) Sets name.
static String	stripPrefixes(String str, String... prefixes) Strip prefixes string.
<T> T	subreport(String subreportName, Function<NotebookOutput,T> fn) Subreport t.
String	summarize(String logSrc, int maxLog) Summarize string.
String	toString(List<CharSequence> list) To string string.
static Consumer<NotebookOutput>	wrapFrontmatter(Consumer<NotebookOutput> fn) Wrap frontmatter consumer.
void	write() Write.
void	write(PrintWriter out) Write markdown with frontmatter.
File	writeZip(File root, String baseName) Write zip.
void	zipArchive(File root, File dir, ZipOutputStream out, Predicate<? super File> filter) Write archive.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.simiacryptus.notebook.NotebookOutput

appendFrontMatterProperty, concat, eval, out, run

Field Detail

random

public static final Random random

The constant random.

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,
                              boolean autobrowse)
                       throws FileNotFoundException

Instantiates a new Markdown notebook output.

Parameters:

reportFile - the file name

autobrowse - the autobrowse

Throws:

FileNotFoundException - the file not found exception

MarkdownNotebookOutput

public MarkdownNotebookOutput(@Nonnull
                              File reportFile)
                       throws FileNotFoundException

Instantiates a new Markdown notebook output.

Parameters:

reportFile - the report file

Throws:

FileNotFoundException - the file not found exception

MarkdownNotebookOutput

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

Instantiates a new Markdown notebook output.

Parameters:

reportFile - the file name

httpPort - the http port

autobrowse - the autobrowse

Throws:

FileNotFoundException - the file not found exception

Method Detail

wrapFrontmatter

public static Consumer<NotebookOutput> wrapFrontmatter(@Nonnull
                                                       Consumer<NotebookOutput> fn)

Wrap frontmatter consumer.

Parameters:

fn - the fn

Returns:

the consumer

get

public static NotebookOutput get(File path,
                                 boolean autobrowse)

Get markdown notebook output.

Parameters:

path - the path

autobrowse - the 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

get

public static NotebookOutput get(String s)

Get notebook output.

Parameters:

s - the s

Returns:

the notebook output

stripPrefixes

public static String stripPrefixes(String str,
                                   String... prefixes)

Strip prefixes string.

Parameters:

str - the str

prefixes - the prefixes

Returns:

the string

close

public void close()
           throws IOException

Specified by:

close in interface NotebookOutput

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getRoot

@Nonnull
public File getRoot()

Gets root.

Specified by:

getRoot in interface NotebookOutput

Returns:

the root

writeZip

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

Write zip.

Parameters:

root - the root

baseName - the base name

Returns:

the file

Throws:

IOException - the io exception

onComplete

@Nonnull
public NotebookOutput onComplete(Runnable... tasks)

On complete markdown notebook output.

Specified by:

onComplete in interface NotebookOutput

Parameters:

tasks - the tasks

Returns:

the markdown notebook output

toString

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

To string string.

Parameters:

list - the list

Returns:

the string

zipArchive

public void zipArchive(File root,
                       File dir,
                       ZipOutputStream out,
                       Predicate<? super File> filter)

Write archive.

Parameters:

root - the root

dir - the dir

out - the out

filter - the filter

write

public void write(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

write

public void write()
           throws IOException

Description copied from interface: NotebookOutput

Write.

Specified by:

write in interface NotebookOutput

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

resolveResource

@Nonnull
public File resolveResource(@Nonnull
                                     CharSequence name)

Resolve resource file.

Parameters:

name - the name

Returns:

the file

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

png

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

Description copied from interface: NotebookOutput

Image string.

Specified by:

png in interface NotebookOutput

Parameters:

rawImage - the raw png

caption - the caption

Returns:

the string

pngFile

@Nonnull
public File pngFile(@Nonnull
                             BufferedImage rawImage,
                             File file)

Description copied from interface: NotebookOutput

Png file file.

Specified by:

pngFile in interface NotebookOutput

Parameters:

rawImage - the raw image

file - the file

Returns:

the file

jpg

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

Description copied from interface: NotebookOutput

Jpg string.

Specified by:

jpg in interface NotebookOutput

Parameters:

rawImage - the raw image

caption - the caption

Returns:

the string

jpgFile

@Nonnull
public File jpgFile(@Nonnull
                             BufferedImage rawImage,
                             File file)

Description copied from interface: NotebookOutput

Jpg file file.

Specified by:

jpgFile in interface NotebookOutput

Parameters:

rawImage - the raw image

file - the file

Returns:

the file

eval

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

Description copied from interface: NotebookOutput

Code t.

Specified by:

eval 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

pathTo

public CharSequence pathTo(@Nonnull
                           File file)

Code file string.

Parameters:

file - the file

Returns:

the string

out

public void out(@Nonnull
                CharSequence 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 FileHTTPD getHttpd()

Description copied from interface: NotebookOutput

Gets httpd.

Specified by:

getHttpd in interface NotebookOutput

Returns:

the httpd

subreport

public <T> T subreport(String subreportName,
                       Function<NotebookOutput,T> fn)

Description copied from interface: NotebookOutput

Subreport t.

Specified by:

subreport in interface NotebookOutput

Type Parameters:

T - the type parameter

Parameters:

subreportName - the report name

fn - the fn

Returns:

the t

isAutobrowse

public boolean isAutobrowse()

Is autobrowse boolean.

Returns:

the boolean

getMaxImageSize

public int getMaxImageSize()

Gets max image size.

Returns:

the max image size

setMaxImageSize

public NotebookOutput setMaxImageSize(int maxImageSize)

Sets max image size.

Parameters:

maxImageSize - the max image size

Returns:

the max image size

getCurrentHome

public URI getCurrentHome()

Description copied from interface: NotebookOutput

Gets current home.

Specified by:

getCurrentHome in interface NotebookOutput

Returns:

the current home

setCurrentHome

public NotebookOutput setCurrentHome(URI currentHome)

Description copied from interface: NotebookOutput

Sets current home.

Specified by:

setCurrentHome in interface NotebookOutput

Parameters:

currentHome - the current home

Returns:

the current home

getArchiveHome

public URI getArchiveHome()

Description copied from interface: NotebookOutput

Gets archive home.

Specified by:

getArchiveHome in interface NotebookOutput

Returns:

the archive home

setArchiveHome

public NotebookOutput setArchiveHome(URI archiveHome)

Description copied from interface: NotebookOutput

Sets archive home.

Specified by:

setArchiveHome in interface NotebookOutput

Parameters:

archiveHome - the archive home

Returns:

the archive home

setName

public NotebookOutput setName(String name)

Description copied from interface: NotebookOutput

Sets name.

Specified by:

setName in interface NotebookOutput

Parameters:

name - the name

Returns:

the name

getReportFile

@Nonnull
public File getReportFile()

Gets report file.

Returns:

the report file

setAutobrowse

public NotebookOutput setAutobrowse(boolean autobrowse)

Description copied from interface: NotebookOutput

Sets autobrowse.

Specified by:

setAutobrowse in interface NotebookOutput

Parameters:

autobrowse - the autobrowse

Returns:

the autobrowse