org.deeplearning4j.ui.standalone

Class StaticPageUtil

java.lang.Object

org.deeplearning4j.ui.standalone.StaticPageUtil

public class StaticPageUtil
extends Object

Idea: Render a set of components as a single static page. The goal here is to provide a simple mechanism for exporting simple pages with static content (charts, etc), where (a) the required UI components, and (b) the data itself, is embedded in the page

This is accomplished using a simple FreeMarker template

Author:

Alex Black

Method Summary

Modifier and Type	Method and Description
static String	renderHTML(Collection<Component> components) Given the specified components, render them to a stand-alone HTML page (which is returned as a String)
static String	renderHTML(Component... components) Given the specified components, render them to a stand-alone HTML page (which is returned as a String)
static String	renderHTMLContent(Component... components)
static void	saveHTMLFile(File outputFile, Component... components) A version of renderHTML(Component...) that exports the resulting HTML to the specified File.
static void	saveHTMLFile(String outputPath, Component... components) A version of renderHTML(Component...) that exports the resulting HTML to the specified path.

Methods inherited from class java.lang.Object

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

Method Detail

renderHTML

public static String renderHTML(Collection<Component> components)

Given the specified components, render them to a stand-alone HTML page (which is returned as a String)

Parameters:

components - Components to render

Returns:

Stand-alone HTML page, as a String

renderHTML

public static String renderHTML(Component... components)

Given the specified components, render them to a stand-alone HTML page (which is returned as a String)

Parameters:

components - Components to render

Returns:

Stand-alone HTML page, as a String

renderHTMLContent

public static String renderHTMLContent(Component... components)
                                throws Exception

Throws:

Exception

saveHTMLFile

public static void saveHTMLFile(String outputPath,
                                Component... components)
                         throws IOException

A version of renderHTML(Component...) that exports the resulting HTML to the specified path.

Parameters:

outputPath - Output path

components - Components to render

Throws:

IOException

saveHTMLFile

public static void saveHTMLFile(File outputFile,
                                Component... components)
                         throws IOException

A version of renderHTML(Component...) that exports the resulting HTML to the specified File.

Parameters:

outputFile - Output path

components - Components to render

Throws:

IOException