Package com.saxonica.serialize
Class SerializerFactoryPE
java.lang.Object
net.sf.saxon.lib.SerializerFactory
com.saxonica.serialize.SerializerFactoryPE
Saxon-PE extensions to the serializer factory
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddTextOutputFilter
(Receiver next, Properties properties) Add a filter to the text output method pipeline.protected void
checkExtensions
(String key) checkOutputProperty
(String key, String value) Check that a supplied output property is valid, and normalize the value (specifically in the case of boolean values where yes|true|1 are normalized to "yes", and no|false|0 are normalized to "no").protected SequenceReceiver
createSaxonSerializationMethod
(String method, SerializationProperties serProps, PipelineConfiguration pipe, CharacterMapExpander characterMapExpander, ProxyReceiver normalizer, ExpandedStreamResult expandedResult, Result result) protected Comparator
<AtomicValue> getPropertySorter
(String propertyOrder) Get a Comparator that sorts key values in a map into the order implied by the serialization property saxon:property-orderprotected ProxyReceiver
newAttributeSorter
(Receiver next, Properties outputProperties) Create a new AttributeSorter, responsible for sorting of attributes into a specified order.protected Emitter
newHTMLEmitter
(Properties properties) Create a new HTML Emitter.protected ProxyReceiver
newHTMLIndenter
(Receiver next, Properties outputProperties) Create a new HTML Indenter.protected Receiver
newNamespaceSorter
(Receiver next, Properties outputProperties) Create a new NamespaceSorter, responsible for sorting of namespaces into a specified order.protected Emitter
newXHTMLEmitter
(Properties properties) Create a new XHTML Emitter.protected ProxyReceiver
newXHTMLIndenter
(Receiver next, Properties outputProperties) Create a new XHTML Indenter.protected Emitter
newXMLEmitter
(Properties properties) Create a new XML Emitter.protected ProxyReceiver
newXMLIndenter
(XMLEmitter next, Properties outputProperties) Create a new XML Indenter.prepareNextStylesheet
(PipelineConfiguration pipe, String href, String baseURI, Result result) Prepare another stylesheet to handle the output of this one.Methods inherited from class net.sf.saxon.lib.SerializerFactory
addHtml5Component, checkListOfEQNames, checkListOfEQNamesAllowingStar, checkNonNegativeInteger, checkYesOrNo, createHTMLSerializer, createTextSerializer, createUserDefinedOutputMethod, createXHTMLSerializer, createXMLSerializer, customizeAdaptiveSerializer, customizeJSONSerializer, getConfiguration, getReceiver, getReceiver, getReceiver, getReceiver, getXMLStreamWriter, injectCharacterMapExpander, injectUnicodeNormalizer, makeSequenceNormalizer, newCDATAFilter, newCharacterMapExpander, newHTMLMetaTagAdjuster, newHTMLURIEscaper, newSequenceWrapper, newTEXTEmitter, newUncommittedSerializer, newUnicodeNormalizer, newXHTMLMetaTagAdjuster, newXHTMLURIEscaper, newXML10ContentChecker
-
Constructor Details
-
SerializerFactoryPE
-
-
Method Details
-
createSaxonSerializationMethod
protected SequenceReceiver createSaxonSerializationMethod(String method, SerializationProperties serProps, PipelineConfiguration pipe, CharacterMapExpander characterMapExpander, ProxyReceiver normalizer, ExpandedStreamResult expandedResult, Result result) throws XPathException - Overrides:
createSaxonSerializationMethod
in classSerializerFactory
- Throws:
XPathException
-
newHTMLIndenter
Description copied from class:SerializerFactory
Create a new HTML Indenter. This method exists so that it can be overridden in a subclass.- Overrides:
newHTMLIndenter
in classSerializerFactory
- Parameters:
next
- the next receiver in the pipelineoutputProperties
- the serialization parameters- Returns:
- the newly created HTML indenter.
-
newXHTMLIndenter
Description copied from class:SerializerFactory
Create a new XHTML Indenter. This method exists so that it can be overridden in a subclass.- Overrides:
newXHTMLIndenter
in classSerializerFactory
- Parameters:
next
- the next receiver in the pipelineoutputProperties
- the serialization parameters- Returns:
- the newly created XHTML indenter.
-
newXMLIndenter
Description copied from class:SerializerFactory
Create a new XML Indenter. This method exists so that it can be overridden in a subclass.- Overrides:
newXMLIndenter
in classSerializerFactory
- Parameters:
next
- the next receiver in the pipelineoutputProperties
- the serialization parameters- Returns:
- the newly created XML indenter.
-
newXMLEmitter
Description copied from class:SerializerFactory
Create a new XML Emitter. This method exists so that it can be overridden in a subclass.- Overrides:
newXMLEmitter
in classSerializerFactory
- Parameters:
properties
- the output properties- Returns:
- the newly created XML emitter.
-
newHTMLEmitter
Description copied from class:SerializerFactory
Create a new HTML Emitter. This method exists so that it can be overridden in a subclass.- Overrides:
newHTMLEmitter
in classSerializerFactory
- Parameters:
properties
- the output properties- Returns:
- the newly created HTML emitter.
-
newAttributeSorter
Create a new AttributeSorter, responsible for sorting of attributes into a specified order. This method exists so that it can be overridden in a subclass.- Overrides:
newAttributeSorter
in classSerializerFactory
- Parameters:
next
- the next receiver in the pipelineoutputProperties
- the serialization parameters- Returns:
- the newly created attribute sorter.
-
newNamespaceSorter
Create a new NamespaceSorter, responsible for sorting of namespaces into a specified order.- Overrides:
newNamespaceSorter
in classSerializerFactory
- Parameters:
next
- the next receiver in the pipelineoutputProperties
- the serialization parameters- Returns:
- the newly created filter.
-
newXHTMLEmitter
Create a new XHTML Emitter. This method exists so that it can be overridden in a subclass.- Overrides:
newXHTMLEmitter
in classSerializerFactory
- Parameters:
properties
- the output properties- Returns:
- the newly created XHTML emitter.
-
addTextOutputFilter
Add a filter to the text output method pipeline. This does nothing unless overridden in a superclass- Overrides:
addTextOutputFilter
in classSerializerFactory
- Parameters:
next
- the next receiver (typically the TextEmitter)properties
- the output properties- Returns:
- the receiver to be used in place of the "next" receiver
- Throws:
XPathException
- if the operation fails
-
prepareNextStylesheet
public SequenceReceiver prepareNextStylesheet(PipelineConfiguration pipe, String href, String baseURI, Result result) throws XPathException Prepare another stylesheet to handle the output of this one.This method is intended for internal use, to support the
saxon:next-in-chain
extension.- Overrides:
prepareNextStylesheet
in classSerializerFactory
- Parameters:
pipe
- the pipeline for the current transformationhref
- URI of the next stylesheet to be appliedbaseURI
- base URI for resolving href if it's a relative URIresult
- the output destination of the current stylesheet- Returns:
- a replacement destination for the current stylesheet
- Throws:
XPathException
- if any dynamic error occurs
-
checkOutputProperty
Check that a supplied output property is valid, and normalize the value (specifically in the case of boolean values where yes|true|1 are normalized to "yes", and no|false|0 are normalized to "no").- Overrides:
checkOutputProperty
in classSerializerFactory
- Parameters:
key
- the name of the property, in Clark formatvalue
- 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- Returns:
- normalized value of the property, or null if the supplied value is null
- Throws:
XPathException
- if the property name or value is invalid
-
checkExtensions
- Overrides:
checkExtensions
in classSerializerFactory
-
getPropertySorter
Get a Comparator that sorts key values in a map into the order implied by the serialization property saxon:property-order- Overrides:
getPropertySorter
in classSerializerFactory
- Parameters:
propertyOrder
- the value of the saxon:property-order serialization property- Returns:
- a Comparator that implements the requested property order
-