uk.ac.ed.ph.snuggletex

Class XMLStringOutputOptions

java.lang.Object

uk.ac.ed.ph.snuggletex.DOMOutputOptions

uk.ac.ed.ph.snuggletex.XMLStringOutputOptions

All Implemented Interfaces:

Cloneable, SerializationSpecifier

Direct Known Subclasses:

WebPageOutputOptions

public class XMLStringOutputOptions
extends DOMOutputOptions
implements SerializationSpecifier

Builds on DOMOutputOptions to add in options for configuring how to build an serialized output consisting of an XML (or possibly HTML) String using the relevant methods in SnuggleSession (e.g. SnuggleSession.buildXMLString(XMLStringOutputOptions)).

Since:

1.2.0

Version:

$Revision$

Author:

David McKain

See Also:

DOMOutputOptions, WebPageOutputOptions, WebPageOutputOptionsBuilder

Nested Class Summary

Nested classes/interfaces inherited from class uk.ac.ed.ph.snuggletex.DOMOutputOptions

DOMOutputOptions.ErrorOutputOptions

Field Summary

Fields inherited from class uk.ac.ed.ph.snuggletex.DOMOutputOptions

DEFAULT_MATHML_PREFIX, DEFAULT_SNUGGLETEX_XML_PREFIX, DEFAULT_XHTML_PREFIX

Fields inherited from interface uk.ac.ed.ph.snuggletex.SerializationSpecifier

DEFAULT_ENCODING, DEFAULT_INDENT

Constructor Summary

Constructors

Constructor and Description
XMLStringOutputOptions()

Method Summary

Modifier and Type	Method and Description
String	getDoctypePublic() Gets the public identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_PUBLIC.
String	getDoctypeSystem() Gets the system identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_SYSTEM.
String	getEncoding() Gets the encoding for the resulting serialized XML.
int	getIndent() Returns the indentation level to use when isIndenting() returns true.
SerializationMethod	getSerializationMethod() Gets the SerializationMethod to use when generating the final output.
boolean	isIncludingXMLDeclaration() Gets whether to include an XML declaration on the resulting output.
boolean	isIndenting() Returns whether the resulting XML will be indented or not.
boolean	isUsingNamedEntities() Returns whether to use named entities for certain MathML symbols rather than numeric character references.
void	setDoctypePublic(String doctypePublic) Sets the public identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_PUBLIC.
void	setDoctypeSystem(String doctypeSystem) Sets the system identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_SYSTEM.
void	setEncoding(String encoding) Sets the encoding for the resulting serialized XML.
void	setIncludingXMLDeclaration(boolean includingXMLDeclaration) Sets whether to include an XML declaration on the resulting output.
void	setIndent(int indent) Sets the indentation level to use when isIndenting() returns true.
void	setIndenting(boolean indenting) Sets whether the resulting XML will be indented or not.
void	setSerializationMethod(SerializationMethod serializationMethod) Sets the SerializationMethod to use when generating the final output.
void	setUsingNamedEntities(boolean usingNamedEntities) Sets whether to use named entities for certain MathML symbols rather than numeric character references.

Methods inherited from class uk.ac.ed.ph.snuggletex.DOMOutputOptions

addDOMPostProcessors, clone, getDOMPostProcessors, getErrorOutputOptions, getInlineCSSProperties, getLinkResolver, getMathMLPrefix, getSnuggleXMLPrefix, getXHTMLPrefix, isAddingMathAnnotations, isAddingMathSourceAnnotations, isApplyingFirefox3SemanticsWorkaround, isInliningCSS, isMathVariantMapping, isPrefixingMathML, isPrefixingSnuggleXML, isPrefixingXHTML, setAddingMathAnnotations, setAddingMathSourceAnnotations, setApplyingFirefox3SemanticsWorkaround, setDOMPostProcessors, setErrorOutputOptions, setInlineCSSProperties, setInliningCSS, setLinkResolver, setMathMLPrefix, setMathVariantMapping, setPrefixingMathML, setPrefixingSnuggleXML, setPrefixingXHTML, setSnuggleXMLPrefix, setXHTMLPrefix

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLStringOutputOptions

public XMLStringOutputOptions()

Method Detail

getSerializationMethod

public SerializationMethod getSerializationMethod()

Gets the SerializationMethod to use when generating the final output.

Default is SerializationMethod.XML. This must not be null.

Note that SerializationMethod.XHTML is only supported properly if you are using an XSLT 2.0 processor; otherwise it reverts to SerializationMethod.XML

Specified by:

getSerializationMethod in interface SerializationSpecifier

setSerializationMethod

public void setSerializationMethod(SerializationMethod serializationMethod)

Sets the SerializationMethod to use when generating the final output. This must not be null.

Note that SerializationMethod.XHTML is only supported properly if you are using an XSLT 2.0 processor; otherwise it reverts to SerializationMethod.XML

Specified by:

setSerializationMethod in interface SerializationSpecifier

Parameters:

serializationMethod - SerializationMethod to use, which must not be null.

getEncoding

public String getEncoding()

Gets the encoding for the resulting serialized XML.

Default is SerializationSpecifier.DEFAULT_ENCODING.

Specified by:

getEncoding in interface SerializationSpecifier

setEncoding

public void setEncoding(String encoding)

Sets the encoding for the resulting serialized XML.

Must not be null.

Specified by:

setEncoding in interface SerializationSpecifier

Parameters:

encoding - encoding to use, which must be non-null and recognised by the XSLT TransformerFactory that will end up doing the serialization.

isIndenting

public boolean isIndenting()

Returns whether the resulting XML will be indented or not. (This depends on how clever the underlying XSLT engine will be!)

Default is false.

Specified by:

isIndenting in interface SerializationSpecifier

setIndenting

public void setIndenting(boolean indenting)

Sets whether the resulting XML will be indented or not. (This depends on how clever the underlying XSLT engine will be!)

NOTE: The old version of Xalan that comes bundled with Java 6 (and below) appears to be unable to indent output when using setIndenting(boolean) with SerializationMethod.HTML. I have not checked this behaviour with Java 7 (or above). I however recommend using Saxon, or including a newer version of Xalan in the ClassPath.

Specified by:

setIndenting in interface SerializationSpecifier

Parameters:

indenting - true to indent, false otherwise.

getIndent

public int getIndent()

Returns the indentation level to use when isIndenting() returns true. (This is currently only supported if your underlying XSLT process is either Saxon or Xalan. This will be the case by if you have chosen to either use Saxon or use the default processor that ships with your Java platform.)

This must be a non-negative integer. The default value is SerializationSpecifier.DEFAULT_INDENT.

Specified by:

getIndent in interface SerializationSpecifier

Since:

1.2.3

setIndent

public void setIndent(int indent)

Sets the indentation level to use when isIndenting() returns true. (This is currently only supported if your underlying XSLT process is either Saxon or Xalan. This will be the case by if you have chosen to either use Saxon or use the default processor that ships with your Java platform.)

This must be a non-negative integer. The default value is SerializationSpecifier.DEFAULT_INDENT.

Specified by:

setIndent in interface SerializationSpecifier

Since:

1.2.3

isIncludingXMLDeclaration

public boolean isIncludingXMLDeclaration()

Gets whether to include an XML declaration on the resulting output. Default is false.

Specified by:

isIncludingXMLDeclaration in interface SerializationSpecifier

setIncludingXMLDeclaration

public void setIncludingXMLDeclaration(boolean includingXMLDeclaration)

Sets whether to include an XML declaration on the resulting output.

Specified by:

setIncludingXMLDeclaration in interface SerializationSpecifier

Parameters:

includingXMLDeclaration - true to include an XML declaration, false otherwise.

isUsingNamedEntities

public boolean isUsingNamedEntities()

Returns whether to use named entities for certain MathML symbols rather than numeric character references.

Default is false.

Specified by:

isUsingNamedEntities in interface SerializationSpecifier

setUsingNamedEntities

public void setUsingNamedEntities(boolean usingNamedEntities)

Sets whether to use named entities for certain MathML symbols rather than numeric character references.

Note that this requires an XSLT 2.0-compliant engine (e.g. Saxon, which is in the "full" SnuggleTeX distribution). This option will be silently ignored if you are using an XSLT 1.0 engine, such as the one which typically comes bundled with your JDK.

(Also note that the resulting XML won't be parseable unless accompanied with a DTD defining the MathML entities!)

Specified by:

setUsingNamedEntities in interface SerializationSpecifier

Parameters:

usingNamedEntities - true to use named entities, false to default to using numeric character references.

getDoctypePublic

public String getDoctypePublic()

Gets the public identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_PUBLIC.

Default is null

Specified by:

getDoctypePublic in interface SerializationSpecifier

setDoctypePublic

public void setDoctypePublic(String doctypePublic)

Sets the public identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_PUBLIC.

Specified by:

setDoctypePublic in interface SerializationSpecifier

Parameters:

doctypePublic - public identifier to use, null for no identifier.

getDoctypeSystem

public String getDoctypeSystem()

Gets the system identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_SYSTEM.

Default is null

Specified by:

getDoctypeSystem in interface SerializationSpecifier

setDoctypeSystem

public void setDoctypeSystem(String doctypeSystem)

Sets the system identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_SYSTEM.

Specified by:

setDoctypeSystem in interface SerializationSpecifier

Parameters:

doctypeSystem - system identifier to use, null for no identifier.