SnuggleTeX 1.3.0 · uk.ac.ed.ph.snuggletex.SnuggleEngine

This is the main entry point into SnuggleTeX.

Usage

Create an instance of this engine and register any extra SnugglePackages you have created or want to use by calling addPackage(SnugglePackage).
Use createSession() to create a "session" that will take one (or more) input documents and produce a DOM.
Each SnuggleSession created will use a _copy_ of the SnugglePackages registered with the engine and _copies_ of the current defaultSessionConfiguration, defaultDOMOutputOptions, and defaultXMLStringOutputOptions. On the other hand, it will use the shared StylesheetManager set for this engine.
As of SnuggleTeX 1.3.0, an instance of this Class can be fully shared by multiple Threads.
Don't let the usual connotations associated with the name of this Class worry you that instantiating it is going to be expensive!

Modifier and Type	Field and Description
private DOMOutputOptions	defaultDOMOutputOptions Default `DOMOutputOptions`
private SessionConfiguration	defaultSessionConfiguration Default `SessionConfiguration`
private XMLStringOutputOptions	defaultXMLStringOutputOptions Default `XMLStringOutputOptions`
private final List<SnugglePackage>	packages List of all currently registered `SnugglePackage`s used by this Engine.
private final StylesheetManager	stylesheetManager Helper class to manage XSLT Stylesheets

Constructor Summary

Access	Constructor and Description
public	SnuggleEngine() Creates a new `SnuggleEngine` using a very simple internal cache for any XSLT stylesheets required that simply stores them internally for the lifetime of the engine.
public	SnuggleEngine(StylesheetCache stylesheetCache) Creates a new `SnuggleEngine` using the given `StylesheetCache` for managing stylesheets.
public	SnuggleEngine(TransformerFactoryChooser transformerFactoryChooser, StylesheetCache stylesheetCache) Creates a new `SnuggleEngine` using the given `StylesheetCache` for managing stylesheets and given `TransformerFactoryChooser` for choosing which XSLT implementation to use.
public	SnuggleEngine(StylesheetManager stylesheetManager) Creates a new `SnuggleEngine` using the given `StylesheetManager` for managing stylesheets.

Method Summary

Modifier and Type	Method and Description
public void	addPackage(SnugglePackage snugglePackage) Registers the given `SnugglePackage` with this `SnuggleEngine`.
public SnuggleSession	createSession() Creates a new `SnuggleSession` using the default `SessionConfiguration` or a fresh `SessionConfiguration` if no default has been set.
public SnuggleSession	createSession(SessionConfiguration `SessionConfiguration` to use, which must not be null. sessionConfiguration) Creates a new `SnuggleSession` using the given `SessionConfiguration`
public SnuggleSimpleMathRunner	createSimpleMathRunner()
public SnuggleSimpleMathRunner	createSimpleMathRunner(SessionConfiguration sessionConfiguration)
public BuiltinCommand	getBuiltinCommandByTeXName(String texName) Returns the `BuiltinCommand` corresponding to LaTeX command called `\texName`, or null if this command is not defined.
public BuiltinEnvironment	getBuiltinEnvironmentByTeXName(String texName) Returns the `BuiltinEnvironment` corresponding to LaTeX environment called `texName`, or null if this environment is not defined.
public DOMOutputOptions	getDefaultDOMOptions() Deprecated Use `getDefaultDOMOutputOptions()`
public DOMOutputOptions	getDefaultDOMOutputOptions() Gets the default `DOMOutputOptions` for this `SnuggleEngine`, which will not be null.
public SessionConfiguration	getDefaultSessionConfiguration() Gets the selected default `SessionConfiguration` for this `SnuggleEngine`, which will not be null.
public XMLStringOutputOptions	getDefaultXMLStringOutputOptions() Gets the default `XMLStringOutputOptions` for this `SnuggleEngine`, which will not be null.
public List<SnugglePackage>	getPackages() Returns a synchronized `List` of all `SnugglePackage`s registered with this engine.
public StylesheetManager	getStylesheetManager() Convenience method to extract the underlying `StylesheetManager` used by this engine.
public void	setDefaultDOMOptions(DOMOutputOptions defaultDOMOptions) Deprecated Use `setDefaultDOMOutputOptions(DOMOutputOptions)`
public void	setDefaultDOMOutputOptions(DOMOutputOptions new `DOMOutputOptions`, which must not be null. defaultDOMOutputOptions) Sets the default `DOMOutputOptions` for this `SnuggleEngine`.
public void	setDefaultSessionConfiguration(SessionConfiguration new default `SessionConfiguration`, which must not be null. defaultSessionConfiguration) Sets the default `SessionConfiguration` for this `SnuggleEngine`.
public void	setDefaultXMLStringOutputOptions(XMLStringOutputOptions new `XMLStringOutputOptions`, which must not be null. defaultXMLOutputOptions) Sets the default `XMLStringOutputOptions` for this `SnuggleEngine`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

defaultDOMOutputOptions	back to summary
private DOMOutputOptions defaultDOMOutputOptions Default `DOMOutputOptions`

defaultSessionConfiguration	back to summary
private SessionConfiguration defaultSessionConfiguration Default `SessionConfiguration`

defaultXMLStringOutputOptions	back to summary
private XMLStringOutputOptions defaultXMLStringOutputOptions Default `XMLStringOutputOptions`

packages	back to summary
private final List<SnugglePackage> packages List of all currently registered `SnugglePackage`s used by this Engine.

stylesheetManager	back to summary
private final StylesheetManager stylesheetManager Helper class to manage XSLT Stylesheets

Constructor Detail

SnuggleEngine back to summary

SnuggleEngine	back to summary
public SnuggleEngine() Creates a new `SnuggleEngine` using a very simple internal cache for any XSLT stylesheets required that simply stores them internally for the lifetime of the engine. The `DefaultTransformerFactoryChooser` is used to choose XSLT implementations. This will be fine in most cases. If you want more control over this, consider the alternative constructor.

public SnuggleEngine()

Creates a new SnuggleEngine using a very simple internal cache for any XSLT stylesheets required that simply stores them internally for the lifetime of the engine. The DefaultTransformerFactoryChooser is used to choose XSLT implementations.

This will be fine in most cases. If you want more control over this, consider the alternative constructor.

SnuggleEngine	back to summary
public SnuggleEngine(StylesheetCache stylesheetCache) Creates a new `SnuggleEngine` using the given `StylesheetCache` for managing stylesheets. Use this if you want to integrate XSLT caching with your own code or want more control over how things get cached. The `DefaultTransformerFactoryChooser` is used to choose XSLT implementations.

SnuggleEngine back to summary

SnuggleEngine	back to summary
public SnuggleEngine(TransformerFactoryChooser transformerFactoryChooser, StylesheetCache stylesheetCache) Creates a new `SnuggleEngine` using the given `StylesheetCache` for managing stylesheets and given `TransformerFactoryChooser` for choosing which XSLT implementation to use. Use this if you want to integrate XSLT caching with your own code, want more control over how things get cached or want to control the selection of XSLT implementations.

public SnuggleEngine(TransformerFactoryChooser transformerFactoryChooser, StylesheetCache stylesheetCache)

Creates a new SnuggleEngine using the given StylesheetCache for managing stylesheets and given TransformerFactoryChooser for choosing which XSLT implementation to use. Use this if you want to integrate XSLT caching with your own code, want more control over how things get cached or want to control the selection of XSLT implementations.

SnuggleEngine	back to summary
public SnuggleEngine(StylesheetManager stylesheetManager) Creates a new `SnuggleEngine` using the given `StylesheetManager` for managing stylesheets. Use this if you want to integrate XSLT caching with your own code, want more control over how things get cached or want to control the selection of XSLT implementations.

Method Detail

addPackage	back to summary
public void addPackage(SnugglePackage snugglePackage) Registers the given `SnugglePackage` with this `SnuggleEngine`. All commands, environments and error codes defined by the `SnugglePackage` will then become available for use.

createSession	back to summary
public SnuggleSession createSession() Creates a new `SnuggleSession` using the default `SessionConfiguration` or a fresh `SessionConfiguration` if no default has been set.

createSession back to summary

createSession	back to summary
public SnuggleSession createSession(SessionConfiguration sessionConfiguration) Creates a new `SnuggleSession` using the given `SessionConfiguration` Parameters sessionConfiguration:SessionConfiguration `SessionConfiguration` to use, which must not be null.

public SnuggleSession createSession(SessionConfiguration sessionConfiguration)

Creates a new SnuggleSession using the given SessionConfiguration

Parameters

sessionConfiguration:SessionConfiguration: SessionConfiguration to use, which must not be null.

createSimpleMathRunner	back to summary
public SnuggleSimpleMathRunner createSimpleMathRunner()

createSimpleMathRunner	back to summary
public SnuggleSimpleMathRunner createSimpleMathRunner(SessionConfiguration sessionConfiguration)

getBuiltinCommandByTeXName	back to summary
public BuiltinCommand getBuiltinCommandByTeXName(String texName) Returns the `BuiltinCommand` corresponding to LaTeX command called `\texName`, or null if this command is not defined.

getBuiltinEnvironmentByTeXName	back to summary
public BuiltinEnvironment getBuiltinEnvironmentByTeXName(String texName) Returns the `BuiltinEnvironment` corresponding to LaTeX environment called `texName`, or null if this environment is not defined.

getDefaultDOMOptions	back to summary
public DOMOutputOptions getDefaultDOMOptions() Deprecated Use `getDefaultDOMOutputOptions()` Annotations @Deprecated

getDefaultDOMOutputOptions	back to summary
public DOMOutputOptions getDefaultDOMOutputOptions() Gets the default `DOMOutputOptions` for this `SnuggleEngine`, which will not be null.

getDefaultSessionConfiguration	back to summary
public SessionConfiguration getDefaultSessionConfiguration() Gets the selected default `SessionConfiguration` for this `SnuggleEngine`, which will not be null.

getDefaultXMLStringOutputOptions	back to summary
public XMLStringOutputOptions getDefaultXMLStringOutputOptions() Gets the default `XMLStringOutputOptions` for this `SnuggleEngine`, which will not be null.

getPackages back to summary

getPackages	back to summary
public List<SnugglePackage> getPackages() Returns a synchronized `List` of all `SnugglePackage`s registered with this engine. Since 1.3.0

public List<SnugglePackage> getPackages()

Returns a synchronized List of all SnugglePackages registered with this engine.

Since: 1.3.0

getStylesheetManager	back to summary
public StylesheetManager getStylesheetManager() Convenience method to extract the underlying `StylesheetManager` used by this engine. Most people won't care about this, but it might be useful if you're trying to integrate stylesheet caching.

setDefaultDOMOptions	back to summary
public void setDefaultDOMOptions(DOMOutputOptions defaultDOMOptions) Deprecated Use `setDefaultDOMOutputOptions(DOMOutputOptions)` Annotations @Deprecated

setDefaultDOMOutputOptions back to summary

setDefaultDOMOutputOptions	back to summary
public void setDefaultDOMOutputOptions(DOMOutputOptions defaultDOMOutputOptions) Sets the default `DOMOutputOptions` for this `SnuggleEngine`. These will be used when calling `SnuggleSession#buildDOMSubtree()`. Parameters defaultDOMOutputOptions:DOMOutputOptions new `DOMOutputOptions`, which must not be null.

public void setDefaultDOMOutputOptions(DOMOutputOptions defaultDOMOutputOptions)

Sets the default DOMOutputOptions for this SnuggleEngine. These will be used when calling SnuggleSession#buildDOMSubtree().

Parameters

defaultDOMOutputOptions:DOMOutputOptions: new DOMOutputOptions, which must not be null.

setDefaultSessionConfiguration back to summary

setDefaultSessionConfiguration	back to summary
public void setDefaultSessionConfiguration(SessionConfiguration defaultSessionConfiguration) Sets the default `SessionConfiguration` for this `SnuggleEngine`. This will be used when creating a new `SnuggleSession` via `createSession()`. Parameters defaultSessionConfiguration:SessionConfiguration new default `SessionConfiguration`, which must not be null.

public void setDefaultSessionConfiguration(SessionConfiguration defaultSessionConfiguration)

Sets the default SessionConfiguration for this SnuggleEngine. This will be used when creating a new SnuggleSession via createSession().

Parameters

defaultSessionConfiguration:SessionConfiguration: new default SessionConfiguration, which must not be null.

setDefaultXMLStringOutputOptions back to summary

setDefaultXMLStringOutputOptions	back to summary
public void setDefaultXMLStringOutputOptions(XMLStringOutputOptions defaultXMLOutputOptions) Sets the default `XMLStringOutputOptions` for this `SnuggleEngine`. These will be used when calling `SnuggleSession#buildXMLString()`. Parameters defaultXMLOutputOptions:XMLStringOutputOptions new `XMLStringOutputOptions`, which must not be null.

public void setDefaultXMLStringOutputOptions(XMLStringOutputOptions defaultXMLOutputOptions)

Sets the default XMLStringOutputOptions for this SnuggleEngine. These will be used when calling SnuggleSession#buildXMLString().

Parameters

defaultXMLOutputOptions:XMLStringOutputOptions: new XMLStringOutputOptions, which must not be null.

public final Class SnuggleEngine

Usage

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail