uk.ac.ed.ph.snuggletex.internal

Class WebPageBuilder

java.lang.Object

uk.ac.ed.ph.snuggletex.internal.WebPageBuilder

public final class WebPageBuilder
extends Object

Builds a web page from a List of fixed FlowTokens, using the supplied WebPageOutputOptions to determine the exact form of the results.

Version:

$Revision$

Author:

David McKain

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_MATHJAX_URL Default URL and config to use when MathJax configuration option has been enabled.

Constructor Summary

Constructors

Constructor and Description
WebPageBuilder(SessionContext sessionContext, WebPageOutputOptions options)

Method Summary

Modifier and Type	Method and Description
Document	buildWebPage(List<FlowToken> fixedTokens)
String	buildWebPageString(List<FlowToken> fixedTokens)
void	setWebPageContentType(Object contentTypeSettable) Calls the setContentType method for the given Object (by reflection) to something appropriate for serving the types of web pages generated by this builder over HTTP.
void	writeWebPage(List<FlowToken> fixedTokens, Object contentTypeSettable, OutputStream outputStream, SnuggleSession.EndOutputAction endOutputOptions) Creates a web page representing the given (fixed) Tokens, and writes the results to the given OutputStream.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MATHJAX_URL

public static final String DEFAULT_MATHJAX_URL

Default URL and config to use when MathJax configuration option has been enabled.

See Also:

Constant Field Values

Constructor Detail

WebPageBuilder

public WebPageBuilder(SessionContext sessionContext,
                      WebPageOutputOptions options)

Method Detail

buildWebPage

public final Document buildWebPage(List<FlowToken> fixedTokens)
                            throws SnuggleParseException

Throws:

SnuggleParseException

buildWebPageString

public final String buildWebPageString(List<FlowToken> fixedTokens)
                                throws SnuggleParseException

Throws:

SnuggleParseException

writeWebPage

public final void writeWebPage(List<FlowToken> fixedTokens,
                               Object contentTypeSettable,
                               OutputStream outputStream,
                               SnuggleSession.EndOutputAction endOutputOptions)
                        throws SnuggleParseException,
                               IOException

Creates a web page representing the given (fixed) Tokens, and writes the results to the given OutputStream.

Parameters:

fixedTokens - fixed Tokens from earlier stages of parsing

contentTypeSettable - optional bean Object that will have its contentType property set if provided. (This is generally useful as a proxy for the HttpResponse Object in the servlet API, which I want to avoid a compile-time dependency on.)

outputStream - Stream to send the resulting page to, which will be closed afterwards.

endOutputOptions - specifies what to do with the outputStream once we've finished writing to it.

Throws:

SnuggleParseException

IOException

SnuggleRuntimeException - if calling setContentType() on the contentTypeSettable Object failed, with the underlying Exception wrapped up.

setWebPageContentType

public final void setWebPageContentType(Object contentTypeSettable)

Calls the setContentType method for the given Object (by reflection) to something appropriate for serving the types of web pages generated by this builder over HTTP.

(The main example for this would be passing a javax.servlet.http.HttpResponse Object, which I want to avoid a compile-time dependency on.)

Parameters:

contentTypeSettable - Object that will have its contentType property set if provided.