Class SaxonOutputKeys

java.lang.Object
net.sf.saxon.lib.SaxonOutputKeys

public class SaxonOutputKeys extends 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
  • Field Details

    • SAXON_XQUERY_METHOD

      public static final String SAXON_XQUERY_METHOD
      String constant representing the saxon:xquery output method name
      See Also:
    • SAXON_BASE64_BINARY_METHOD

      public static final String SAXON_BASE64_BINARY_METHOD
      String constant representing the saxon:base64Binary output method name
      See Also:
    • SAXON_HEX_BINARY_METHOD

      public static final String SAXON_HEX_BINARY_METHOD
      String constant representing the saxon:hexBinary output method name
      See Also:
    • SAXON_PTREE_METHOD

      public static final String SAXON_PTREE_METHOD
      String constant representing the saxon:ptree output method name
      See Also:
    • INDENT_SPACES

      public static final String INDENT_SPACES
      saxon:indent-spaces = integer.

      Defines the number of spaces used for indentation of output

      See Also:
    • LINE_LENGTH

      public static final String LINE_LENGTH
      saxon:line-length = integer.

      Defines the desired maximum line length used when indenting output

      See Also:
    • SAXON_SUPPRESS_INDENTATION

      public static final String SAXON_SUPPRESS_INDENTATION
      Deprecated.
      use SUPPRESS_INDENTATION (the output property has been adopted as a standard property in XSLT 3.0, it is no longer Saxon-specific)
      saxon:suppress-indentation = list of element names

      Defines elements within which no indentation will occur

      See Also:
    • SUPPRESS_INDENTATION

      public static final String SUPPRESS_INDENTATION
      suppress-indentation = list of element names

      Defines elements within which no indentation will occur

      See Also:
    • DOUBLE_SPACE

      public static final String DOUBLE_SPACE
      saxon:double-space = list of element names

      Defines elements that will have an extra blank line added before the start tag, in addition to normal indentation

      See Also:
    • 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.
      See Also:
    • 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.

      See Also:
    • 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

      See Also:
    • 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

      See Also:
    • 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

      See Also:
    • 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.

      See Also:
    • 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.

      See Also:
    • NEXT_IN_CHAIN_BASE_URI

      public static final String NEXT_IN_CHAIN_BASE_URI
      See Also:
    • 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"

      See Also:
    • 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.

      See Also:
    • RECOGNIZE_BINARY

      public static final String RECOGNIZE_BINARY
      recognize-binary = yes|no.

      If set to "yes", and the output is being written using output method "text", Saxon will recognize two processing instructions <?hex XXXX?> and <b64 XXXX?> containing binary data encoded as a hexBinary or base64 string respectively. The corresponding strings will be decoded as characters in the encoding being used for the output file, and will be written out to the output without checking that they represent valid XML strings.

      See Also:
    • 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".

      See Also:
    • 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.

      See Also:
    • 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.

      See Also:
    • IMPLICIT_RESULT_DOCUMENT

      public static final String IMPLICIT_RESULT_DOCUMENT
      Property used internally to identify the XSLT implicit result document
      See Also:
  • Method Details

    • checkOutputProperty

      public static void checkOutputProperty(String key, String value, Configuration config) throws XPathException
      Check that a supplied output property is valid.
      Parameters:
      key - the name of the property
      value - 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 names
      config - the Saxon Configuration. May be null, in which case validation may be incomplete
      Throws:
      XPathException - if the property name or value is invalid
    • parseListOfElementNames

      public static String parseListOfElementNames(String value, NamespaceResolver nsResolver, boolean prevalidated, NameChecker checker, String errorCode) throws XPathException
      Process a serialization property whose value is a list of element names, for example cdata-section-elements
      Parameters:
      value - The value of the property as written
      nsResolver - The namespace resolver to use; may be null if prevalidated is set or if names are supplied in Clark format
      prevalidated - true if the property has already been validated
      checker - The name checker to use for name syntax (XML 1.0 or XML 1.1)
      errorCode - The error code to return in the event of problems
      Returns:
      The list of element names with lexical QNames replaced by Clark names, starting with a single space
      Throws:
      XPathException - if any error is found in the list of element names, for example, an undeclared namespace prefix