net.sf.saxon.event
Class SaxonOutputKeys
java.lang.Object
net.sf.saxon.event.SaxonOutputKeys
public class SaxonOutputKeys
extends java.lang.Object
Provides string constants that can be used to set
output properties for a Transformer, or to retrieve
output properties from a Transformer or Templates object.
These keys are private Saxon keys that supplement the standard keys
defined in javax.xml.transform.OutputKeys. As well as Saxon extension
attributes, the list includes new attributes defined in XSLT 2.0 which
are not yet supported in JAXP
BYTE_ORDER_MARK
public static final String BYTE_ORDER_MARK
byte-order-mark = yes|no.
Indicates whether UTF-8/UTF-16 output is to start with a byte order mark. Values are "yes" or "no",
default is "no"
CHARACTER_REPRESENTATION
public static final String CHARACTER_REPRESENTATION
representation = rep1[;rep2].
Indicates the preferred way of representing non-ASCII characters in HTML
and XML output. rep1 is for characters in the range 128-256, rep2 for those
above 256.
ESCAPE_URI_ATTRIBUTES
public static final String ESCAPE_URI_ATTRIBUTES
escape-uri-attributes = "yes" | "no". This attribute is defined in XSLT 2.0
Indicates whether HTML attributes of type URI are to be URI-escaped
IMPLICIT_RESULT_DOCUMENT
public static final String IMPLICIT_RESULT_DOCUMENT
Property used internally to identify the XSLT implicit result document
INCLUDE_CONTENT_TYPE
public static final String INCLUDE_CONTENT_TYPE
include-content-type = "yes" | "no". This attribute is defined in XSLT 2.0
Indicates whether the META tag is to be added to HTML output
INDENT_SPACES
public static final String INDENT_SPACES
saxon:indentSpaces = integer.
Defines the number of spaces used for indentation of output
NEXT_IN_CHAIN
public static final String NEXT_IN_CHAIN
saxon:next-in-chain = URI.
Indicates that the output is to be piped into another XSLT stylesheet
to perform another transformation. The auxiliary property NEXT_IN_CHAIN_BASE_URI
records the base URI of the stylesheet element where this attribute was found.
NEXT_IN_CHAIN_BASE_URI
public static final String NEXT_IN_CHAIN_BASE_URI
NORMALIZATION_FORM
public static final String NORMALIZATION_FORM
normalization-form = NFC|NFD|NFKC|NFKD|non.
Indicates that a given Unicode normalization form (or no normalization) is required.
REQUIRE_WELL_FORMED
public static final String REQUIRE_WELL_FORMED
saxon:require-well-formed = yes|no.
Indicates whether a user-supplied ContentHandler requires the stream of SAX events to be
well-formed (that is, to have a single element node and no text nodes as children of the root).
The default is "no".
SAXON_XQUERY_METHOD
public static final String SAXON_XQUERY_METHOD
String constant representing the saxon:xquery output method name
STYLESHEET_VERSION
public static final String STYLESHEET_VERSION
stylesheet-version. This serialization parameter is set automatically by the XSLT processor
to the value of the version attribute on the principal stylesheet module.
SUPPLY_SOURCE_LOCATOR
public static final String SUPPLY_SOURCE_LOCATOR
supply-source-locator = yes|no.
If set to "yes", and the output is being sent to a SAXResult (or to a user-supplied content handler),
indicates that the SAX Locator made available to the ContentHandler will contain information about the
location of the context node in the source document as well as the location in the stylesheet or query.
SUPPRESS_INDENTATION
public static final String SUPPRESS_INDENTATION
saxon:suppress-indentation = list of element names
UNDECLARE_PREFIXES
public static final String UNDECLARE_PREFIXES
undeclare-prefixes = "yes" | "no". This attribute is defined in XSLT 2.0
Indicates XML 1.1 namespace undeclarations are to be output when required
USE_CHARACTER_MAPS
public static final String USE_CHARACTER_MAPS
use-character-map = list-of-qnames.
Defines the character maps used in this output definition. The QNames
are represented in Clark notation as {uri}local-name.
WRAP
public static final String WRAP
wrap="yes"|"no".
This property is only available in the XQuery API. The value "yes" indicates that the result
sequence produced by the query is to be wrapped, that is, each item in the result is represented
as a separate element. This format allows any sequence to be represented as an XML document,
including for example sequences consisting of parentless attribute nodes.
checkOutputProperty
public static void checkOutputProperty(String key,
String value,
NameChecker checker)
throws XPathException
Check that a supplied output property is valid.
key
- the name of the propertyvalue
- the value of the property. This may be set to null, in which case no validation takes place.
The value must be in JAXP format, that is, with lexical QNames expanded to Clark nameschecker
- the NameChecker to be used for validating QNames