uk.ac.ed.ph.snuggletex

类 SnuggleSession

java.lang.Object

uk.ac.ed.ph.snuggletex.SnuggleSession

所有已实现的接口:

SessionContext

public final class SnuggleSession
extends java.lang.Object
implements SessionContext

This represents a single "job" for SnuggleTeX.

Usage

• Create a session with SnuggleEngine.createSession(), optionally passing configuration details for this session.
• Call parseInput(SnuggleInput) on one or more input documents to tokenise and fix-up the LaTeX contained therein.
• Call one or more of the DOM and/or web page building methods to generate the appropriate type of output.
• Call getErrors() to get at the errors that have arisen during this session.
• Call createSnapshot() at any time to make a "snapshot" of the current state for later reuse.
• An instance of this Class should only be used by one Thread at a time. It is stateful and intended to be discarded after use.

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	SnuggleSession.EndOutputAction Trivial enumeration which specifies the possible actions to perform once we finish writing with the various writeWebPage(WebPageOutputOptions, OutputStream) methods.

方法概要

限定符和类型	方法和说明
org.w3c.dom.NodeList	buildDOMSubtree() Convenience method to build a DOM NodeList representing the converted Tokens.
org.w3c.dom.NodeList	buildDOMSubtree(DOMOutputOptions options) Convenience method to build a DOM NodeList representing the converted Tokens.
boolean	buildDOMSubtree(org.w3c.dom.Element targetRoot) Builds a DOM sub-tree based on the currently parsed tokens, appending the results as children of the given target root Element.
boolean	buildDOMSubtree(org.w3c.dom.Element targetRoot, DOMOutputOptions options) Builds a DOM sub-tree based on the currently parsed tokens, appending the results as children of the given target root Element.
org.w3c.dom.Document	buildWebPage(WebPageOutputOptions options) Builds a complete web page based on the currently parsed tokens, returning a DOM Document Object.
java.lang.String	buildWebPageString(WebPageOutputOptions options) Builds a complete web page based on the currently parsed tokens, returning a String containing the resulting content.
java.lang.String	buildXMLString() Creates a well-formed external general parsed entity out of the currently parsed tokens.
java.lang.String	buildXMLString(boolean indent) 已过时。 Use buildXMLString(XMLStringOutputOptions) instead
java.lang.String	buildXMLString(DOMOutputOptions options) 已过时。 Use buildXMLString(XMLStringOutputOptions) instead.
java.lang.String	buildXMLString(DOMOutputOptions options, boolean indent) 已过时。 Use buildXMLString(XMLStringOutputOptions) instead.
java.lang.String	buildXMLString(XMLStringOutputOptions options) Creates a well-formed external general parsed entity out of the currently parsed tokens.
SnuggleSnapshot	createSnapshot() Creates a SnuggleSnapshot Object holding the current state of this session that can be later used to recreate a session having exactly the same state.
org.w3c.dom.Document	createWebPage(WebPageOutputOptions options) 已过时。
BuiltinCommand	getBuiltinCommandByTeXName(java.lang.String texName) Returns the BuiltinCommand corresponding to LaTeX command called \texName, or null if this command is not defined.
BuiltinEnvironment	getBuiltinEnvironmentByTeXName(java.lang.String texName) Returns the BuiltinEnvironment corresponding to LaTeX environment called texName, or null if this environment is not defined.
SessionConfiguration	getConfiguration()
java.util.List<InputError>	getErrors()
MathCharacter	getMathCharacter(int codePoint)
java.util.List<FlowToken>	getParsedTokens()
StylesheetManager	getStylesheetManager() Gets the StylesheetManager being used by the underlying SnuggleEngine
java.util.Map<java.lang.String,UserDefinedCommand>	getUserCommandMap() Gets the Map of all user-defined commands created in this session.
java.util.Map<java.lang.String,UserDefinedEnvironment>	getUserEnvironmentMap() Gets the Map of all user-defined environments created in this session.
boolean	parseInput(SnuggleInput snuggleInput) Parses the data contained within the given SnuggleInput, and performs fixing on the resulting tokens.
void	registerError(InputError inputError) Records a new error, throwing a SnuggleParseException if the current SessionConfiguration deems that we should fail on the first error.
void	reset() Resets this SnuggleSession back to an initial blank state
void	setWebPageContentType(WebPageOutputOptions options, java.lang.Object contentTypeSettable) Calls the setContentType of the given Object to something appropriate for the given WebPageOutputOptions.
boolean	writeWebPage(WebPageOutputOptions options, java.lang.Object contentTypeSettable, java.io.OutputStream outputStream) Builds a complete web page based on the currently parsed tokens, sending the results to the given OutputStream, which is closed afterwards.
boolean	writeWebPage(WebPageOutputOptions options, java.lang.Object contentTypeSettable, java.io.OutputStream outputStream, SnuggleSession.EndOutputAction endOutputAction) Builds a complete web page based on the currently parsed tokens, sending the results to the given OutputStream and performing the given SnuggleSession.EndOutputAction to it afterwards (i.e. close, flush or do nothing).
boolean	writeWebPage(WebPageOutputOptions options, java.io.OutputStream outputStream) Builds a complete web page based on the currently parsed tokens, sending the results to the given OutputStream, which is closed afterwards.
boolean	writeWebPage(WebPageOutputOptions options, java.io.OutputStream outputStream, SnuggleSession.EndOutputAction endOutputAction) Builds a complete web page based on the currently parsed tokens, sending the results to the given OutputStream and performing the given SnuggleSession.EndOutputAction to it afterwards (i.e. close, flush or do nothing).

从类继承的方法 java.lang.Object

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

方法详细资料

getConfiguration

public SessionConfiguration getConfiguration()

指定者:

getConfiguration 在接口中 SessionContext

getErrors

public java.util.List<InputError> getErrors()

指定者:

getErrors 在接口中 SessionContext

getParsedTokens

public java.util.List<FlowToken> getParsedTokens()

parseInput

public boolean parseInput(SnuggleInput snuggleInput)
                   throws java.io.IOException

Parses the data contained within the given SnuggleInput, and performs fixing on the resulting tokens.

参数:

snuggleInput - input to parse, which must not be null

返回:

true if parsing finished, false if it was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

抛出:

java.io.IOException

createSnapshot

public SnuggleSnapshot createSnapshot()

Creates a SnuggleSnapshot Object holding the current state of this session that can be later used to recreate a session having exactly the same state.

reset

public void reset()

Resets this SnuggleSession back to an initial blank state

buildDOMSubtree

public boolean buildDOMSubtree(org.w3c.dom.Element targetRoot,
                               DOMOutputOptions options)

Builds a DOM sub-tree based on the currently parsed tokens, appending the results as children of the given target root Element. The given DOMOutputOptions Object is used to configure the process.

If the DOMOutputOptions specifies that MathML should be down-converted to XHTML where possible, then this will also happen.

返回:

true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

buildDOMSubtree

public boolean buildDOMSubtree(org.w3c.dom.Element targetRoot)

Builds a DOM sub-tree based on the currently parsed tokens, appending the results as children of the given target root Element. This uses the default DOMOutputOptions associated with this engine.

返回:

true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

buildDOMSubtree

public org.w3c.dom.NodeList buildDOMSubtree()

Convenience method to build a DOM NodeList representing the converted Tokens. These Nodes will belong to a "fake root" element in the SnuggleConstants.SNUGGLETEX_NAMESPACE namespace called "root".

The default DOMOutputOptions specified in the SnuggleEngine will be used.

返回:

resulting NodeList if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

buildDOMSubtree

public org.w3c.dom.NodeList buildDOMSubtree(DOMOutputOptions options)

Convenience method to build a DOM NodeList representing the converted Tokens. These Nodes will belong to a "fake root" element in the SnuggleConstants.SNUGGLETEX_NAMESPACE namespace called "root".

The given DOMOutputOptions Object is used to configure the process, which must not be null.

参数:

options - DOMOutputOptions to use, which must not be null

返回:

resulting NodeList if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

buildXMLString

public java.lang.String buildXMLString()

Creates a well-formed external general parsed entity out of the currently parsed tokens.

The default XMLStringOutputOptions specified in the SnuggleEngine will be used.

返回:

resulting XML if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

buildXMLString

public java.lang.String buildXMLString(XMLStringOutputOptions options)

Creates a well-formed external general parsed entity out of the currently parsed tokens.

The given XMLStringOutputOptions Object is used to configure the process.

参数:

options - XMLStringOutputOptions to use, which must not be null.

返回:

resulting XML if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

buildXMLString

@Deprecated
public java.lang.String buildXMLString(boolean indent)

已过时。 Use buildXMLString(XMLStringOutputOptions) instead

Convenience method to create a well-formed external general parsed entity out of the currently parsed tokens.

The default DOMOutputOptions specified in the SnuggleEngine will be used.

参数:

indent - whether to indent the resulting XML or not

返回:

resulting XML if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

buildXMLString

@Deprecated
public java.lang.String buildXMLString(DOMOutputOptions options)

已过时。 Use buildXMLString(XMLStringOutputOptions) instead.

Convenience method to create a well-formed external general parsed entity out of the currently parsed tokens.

The given DOMOutputOptions Object is used to configure the process.

返回:

resulting XML if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

buildXMLString

@Deprecated
public java.lang.String buildXMLString(DOMOutputOptions options,
                                                    boolean indent)

已过时。 Use buildXMLString(XMLStringOutputOptions) instead.

Convenience method to create a well-formed external general parsed entity out of the currently parsed tokens.

The given DOMOutputOptions Object is used to configure the process.

参数:

indent - whether to indent the resulting XML or not

返回:

resulting XML if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

buildWebPage

public org.w3c.dom.Document buildWebPage(WebPageOutputOptions options)

Builds a complete web page based on the currently parsed tokens, returning a DOM Document Object.

The provided WebPageOutputOptions Object is used to determine which type of web page to generate and how it should be configured.

Any XSLT stylesheet specified by WebPageOutputOptions.getStylesheets() will have been applied to the result before it is returned. On the other hand, serialisation options in the WebPageOutputOptions (such as Content Type and encoding) will not have been applied when this method returns.

返回:

resulting Document if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

createWebPage

@Deprecated
public org.w3c.dom.Document createWebPage(WebPageOutputOptions options)

已过时。

For naming consistency, please use buildWebPage(WebPageOutputOptions) instead.

buildWebPageString

public java.lang.String buildWebPageString(WebPageOutputOptions options)

Builds a complete web page based on the currently parsed tokens, returning a String containing the resulting content. This is a convenience method; using writeWebPage(WebPageOutputOptions, OutputStream) might be more efficient.

The provided WebPageOutputOptions Object is used to determine which type of web page to generate and how it should be configured.

Any XSLT stylesheet specified by WebPageOutputOptions.getStylesheets() will have been applied to the result before it is returned. On the other hand, serialisation options in the WebPageOutputOptions (such as Content Type and encoding) will not have been applied when this method returns.

返回:

resulting Document if the process completed successfully, null if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

从以下版本开始:

1.3.0

writeWebPage

public boolean writeWebPage(WebPageOutputOptions options,
                            java.io.OutputStream outputStream)
                     throws java.io.IOException

Builds a complete web page based on the currently parsed tokens, sending the results to the given OutputStream, which is closed afterwards.

The provided WebPageOutputOptions Object is used to determine which type of web page to generate and how it should be configured.

返回:

true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

抛出:

java.io.IOException

writeWebPage

public boolean writeWebPage(WebPageOutputOptions options,
                            java.io.OutputStream outputStream,
                            SnuggleSession.EndOutputAction endOutputAction)
                     throws java.io.IOException

Builds a complete web page based on the currently parsed tokens, sending the results to the given OutputStream and performing the given SnuggleSession.EndOutputAction to it afterwards (i.e. close, flush or do nothing).

The provided WebPageOutputOptions Object is used to determine which type of web page to generate and how it should be configured.

返回:

true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

抛出:

java.io.IOException

从以下版本开始:

1.2.2

writeWebPage

public boolean writeWebPage(WebPageOutputOptions options,
                            java.lang.Object contentTypeSettable,
                            java.io.OutputStream outputStream)
                     throws java.io.IOException

Builds a complete web page based on the currently parsed tokens, sending the results to the given OutputStream, which is closed afterwards.

The provided WebPageOutputOptions Object is used to determine which type of web page to generate and how it should be configured.

If the contentTypeSettable Object has a property called contentType, then it is set in advance to the appropriate HTTP Content-Type header for the resulting page before the web page data is written.

返回:

true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

抛出:

java.io.IOException - if an I/O problem arose whilst writing out the web page data.

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

writeWebPage

public boolean writeWebPage(WebPageOutputOptions options,
                            java.lang.Object contentTypeSettable,
                            java.io.OutputStream outputStream,
                            SnuggleSession.EndOutputAction endOutputAction)
                     throws java.io.IOException

Builds a complete web page based on the currently parsed tokens, sending the results to the given OutputStream and performing the given SnuggleSession.EndOutputAction to it afterwards (i.e. close, flush or do nothing).

The provided WebPageOutputOptions Object is used to determine which type of web page to generate and how it should be configured.

If the contentTypeSettable Object has a property called contentType, then it is set in advance to the appropriate HTTP Content-Type header for the resulting page before the web page data is written.

返回:

true if completed successfully, false if the process was terminated by an error in the input LaTeX and if the session was configured to fail on the first error.

抛出:

java.io.IOException - if an I/O problem arose whilst writing out the web page data.

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

从以下版本开始:

1.2.2

setWebPageContentType

public void setWebPageContentType(WebPageOutputOptions options,
                                  java.lang.Object contentTypeSettable)

Calls the setContentType of the given Object to something appropriate for the given WebPageOutputOptions. This may be useful in some cases.

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

另请参阅:

writeWebPage(WebPageOutputOptions, Object, OutputStream)

getMathCharacter

public MathCharacter getMathCharacter(int codePoint)

指定者:

getMathCharacter 在接口中 SessionContext

getBuiltinCommandByTeXName

public BuiltinCommand getBuiltinCommandByTeXName(java.lang.String texName)

Returns the BuiltinCommand corresponding to LaTeX command called \texName, or null if this command is not defined.

指定者:

getBuiltinCommandByTeXName 在接口中 SessionContext

getBuiltinEnvironmentByTeXName

public BuiltinEnvironment getBuiltinEnvironmentByTeXName(java.lang.String texName)

Returns the BuiltinEnvironment corresponding to LaTeX environment called texName, or null if this environment is not defined.

指定者:

getBuiltinEnvironmentByTeXName 在接口中 SessionContext

getUserCommandMap

public java.util.Map<java.lang.String,UserDefinedCommand> getUserCommandMap()

Gets the Map of all user-defined commands created in this session.

指定者:

getUserCommandMap 在接口中 SessionContext

getUserEnvironmentMap

public java.util.Map<java.lang.String,UserDefinedEnvironment> getUserEnvironmentMap()

Gets the Map of all user-defined environments created in this session.

指定者:

getUserEnvironmentMap 在接口中 SessionContext

getStylesheetManager

public StylesheetManager getStylesheetManager()

Gets the StylesheetManager being used by the underlying SnuggleEngine

指定者:

getStylesheetManager 在接口中 SessionContext

registerError

public void registerError(InputError inputError)
                   throws SnuggleParseException

Records a new error, throwing a SnuggleParseException if the current SessionConfiguration deems that we should fail on the first error.

指定者:

registerError 在接口中 SessionContext

参数:

inputError - InputError to register, which must not be null.

抛出:

SnuggleParseException - if this session is configured to fail fast