com.simiacryptus.notebook

Interface NotebookOutput

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

MarkdownNotebookOutput, NullNotebookOutput

public interface NotebookOutput
extends Closeable

The interface Notebook output.

Method Summary

Modifier and Type	Method and Description
default void	appendFrontMatterProperty(CharSequence key, CharSequence value, CharSequence delimiter) Append front matter property.
void	close()
static Consumer<NotebookOutput>	concat(Consumer<NotebookOutput> fn, Consumer<NotebookOutput> header) Concat consumer.
default <T> T	eval(UncheckedSupplier<T> fn) Code t.
<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.
URI	getArchiveHome() Gets archive home.
URI	getCurrentHome() Gets current home.
CharSequence	getFrontMatterProperty(CharSequence key) Gets front matter property.
FileHTTPD	getHttpd() Gets httpd.
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	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 notebook output.
default void	out(CharSequence fmt, Object... args) Out.
default <T> T	out(UncheckedSupplier<T> fn) Code t.
void	p(CharSequence fmt, Object... args) P.
String	png(BufferedImage rawImage, CharSequence caption) Image string.
File	pngFile(BufferedImage rawImage, File file) Png file file.
default void	run(Runnable fn) Code.
NotebookOutput	setArchiveHome(URI archiveHome) Sets archive home.
NotebookOutput	setAutobrowse(boolean autobrowse) Sets autobrowse.
NotebookOutput	setCurrentHome(URI currentHome) Sets current home.
default void	setFrontMatterProperty(CharSequence key, CharSequence value) Sets fm prop.
NotebookOutput	setName(String name) Sets name.
<T> T	subreport(String reportName, Function<NotebookOutput,T> fn) Subreport t.
void	write() Write.

Method Detail

concat

static Consumer<NotebookOutput> concat(@Nonnull
                                       Consumer<NotebookOutput> fn,
                                       @Nonnull
                                       Consumer<NotebookOutput> header)

Concat consumer.

Parameters:

fn - the fn

header - the header

Returns:

the consumer

run

default void run(@Nonnull
                 Runnable fn)

Code.

Parameters:

fn - the fn

eval

default <T> T eval(UncheckedSupplier<T> fn)

Code t.

Type Parameters:

T - the type parameter

Parameters:

fn - the fn

Returns:

the t

out

default <T> T out(UncheckedSupplier<T> fn)

Code t.

Type Parameters:

T - the type parameter

Parameters:

fn - the fn

Returns:

the t

pngFile

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

Png file file.

Parameters:

rawImage - the raw image

file - the file

Returns:

the file

jpg

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

Jpg string.

Parameters:

rawImage - the raw image

caption - the caption

Returns:

the string

jpgFile

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

Jpg file file.

Parameters:

rawImage - the raw image

file - the file

Returns:

the file

eval

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

Code t.

Type Parameters:

T - the type parameter

Parameters:

fn - the fn

maxLog - the max log

framesNo - the frames no

Returns:

the t

write

void write()
    throws IOException

Write.

Throws:

IOException - the io exception

file

@Nonnull
OutputStream file(CharSequence name)

File output stream.

Parameters:

name - the name

Returns:

the output stream

file

@Nonnull
String file(CharSequence data,
                     CharSequence caption)

File string.

Parameters:

data - the data

caption - the caption

Returns:

the string

file

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

File string.

Parameters:

data - the data

filename - the filename

caption - the caption

Returns:

the string

file

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

File string.

Parameters:

data - the data

fileName - the file name

caption - the caption

Returns:

the string

h1

void h1(CharSequence fmt,
        Object... args)

H 1.

Parameters:

fmt - the fmt

args - the args

h2

void h2(CharSequence fmt,
        Object... args)

H 2.

Parameters:

fmt - the fmt

args - the args

h3

void h3(CharSequence fmt,
        Object... args)

H 3.

Parameters:

fmt - the fmt

args - the args

png

@Nonnull
String png(BufferedImage rawImage,
                    CharSequence caption)

Image string.

Parameters:

rawImage - the raw png

caption - the caption

Returns:

the string

link

CharSequence link(File file,
                  CharSequence text)

Link string.

Parameters:

file - the file

text - the text

Returns:

the string

out

default void out(CharSequence fmt,
                 Object... args)

Out.

Parameters:

fmt - the fmt

args - the args

p

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

P.

Parameters:

fmt - the fmt

args - the args

getRoot

@Nonnull
File getRoot()

Gets root.

Returns:

the root

onComplete

@Nonnull
NotebookOutput onComplete(Runnable... tasks)

On complete notebook output.

Parameters:

tasks - the tasks

Returns:

the notebook output

close

void close()
    throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

setFrontMatterProperty

default void setFrontMatterProperty(CharSequence key,
                                    CharSequence value)

Sets fm prop.

Parameters:

key - the key

value - the value

appendFrontMatterProperty

default void appendFrontMatterProperty(CharSequence key,
                                       CharSequence value,
                                       CharSequence delimiter)

Append front matter property.

Parameters:

key - the key

value - the value

delimiter - the delimiter

getFrontMatterProperty

@Nullable
CharSequence getFrontMatterProperty(CharSequence key)

Gets front matter property.

Parameters:

key - the key

Returns:

the front matter property

getName

CharSequence getName()

Gets name.

Returns:

the name

setName

NotebookOutput setName(String name)

Sets name.

Parameters:

name - the name

Returns:

the name

getResourceDir

@Nonnull
File getResourceDir()

Gets resource dir.

Returns:

the resource dir

getMaxOutSize

int getMaxOutSize()

Gets max out size.

Returns:

the max out size

getHttpd

FileHTTPD getHttpd()

Gets httpd.

Returns:

the httpd

subreport

<T> T subreport(String reportName,
                Function<NotebookOutput,T> fn)

Subreport t.

Type Parameters:

T - the type parameter

Parameters:

reportName - the report name

fn - the fn

Returns:

the t

getCurrentHome

URI getCurrentHome()

Gets current home.

Returns:

the current home

setCurrentHome

NotebookOutput setCurrentHome(URI currentHome)

Sets current home.

Parameters:

currentHome - the current home

Returns:

the current home

getArchiveHome

URI getArchiveHome()

Gets archive home.

Returns:

the archive home

setArchiveHome

NotebookOutput setArchiveHome(URI archiveHome)

Sets archive home.

Parameters:

archiveHome - the archive home

Returns:

the archive home

setAutobrowse

NotebookOutput setAutobrowse(boolean autobrowse)

Sets autobrowse.

Parameters:

autobrowse - the autobrowse

Returns:

the autobrowse