Package net.sf.saxon.event
Class Stripper
- java.lang.Object
-
- net.sf.saxon.event.SequenceReceiver
-
- net.sf.saxon.event.ProxyReceiver
-
- net.sf.saxon.event.Stripper
-
- All Implemented Interfaces:
javax.xml.transform.Result,Receiver
public class Stripper extends ProxyReceiver
The RuleBasedStripper class performs whitespace stripping according to the rules of the xsl:strip-space and xsl:preserve-space instructions. It maintains details of which elements need to be stripped. The code is written to act as a SAX-like filter to do the stripping.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classStripper.StripRuleTarget
-
Field Summary
Fields Modifier and Type Field Description static byteALWAYS_PRESERVEstatic byteALWAYS_STRIPstatic byteASSERTIONS_EXISTstatic Stripper.StripRuleTargetPRESERVEstatic bytePRESERVE_PARENTprotected SpaceStrippingRulerulestatic byteSIMPLE_CONTENTstatic Stripper.StripRuleTargetSTRIPstatic byteSTRIP_DEFAULT-
Fields inherited from class net.sf.saxon.event.ProxyReceiver
nextReceiver
-
Fields inherited from class net.sf.saxon.event.SequenceReceiver
pipelineConfiguration, previousAtomic, systemId
-
-
Constructor Summary
Constructors Constructor Description Stripper(SpaceStrippingRule rule, Receiver next)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcharacters(java.lang.CharSequence chars, Location locationId, int properties)Handle a text nodevoidendElement()Handle an end-of-element eventStrippergetAnother(Receiver next)Get a clean copy of this stripper.voidopen()Callback interface for SAX: not for application usevoidstartElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties)Notify the start of an elementbooleanusesTypeAnnotations()Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events-
Methods inherited from class net.sf.saxon.event.ProxyReceiver
append, close, comment, endDocument, getNamePool, getNextReceiver, processingInstruction, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startDocument
-
Methods inherited from class net.sf.saxon.event.SequenceReceiver
append, decompose, flatten, getConfiguration, getErrorCodeForDecomposingFunctionItems, getPipelineConfiguration, getSystemId, handlesAppend
-
-
-
-
Field Detail
-
STRIP
public static final Stripper.StripRuleTarget STRIP
-
PRESERVE
public static final Stripper.StripRuleTarget PRESERVE
-
rule
protected SpaceStrippingRule rule
-
ALWAYS_PRESERVE
public static final byte ALWAYS_PRESERVE
- See Also:
- Constant Field Values
-
ALWAYS_STRIP
public static final byte ALWAYS_STRIP
- See Also:
- Constant Field Values
-
STRIP_DEFAULT
public static final byte STRIP_DEFAULT
- See Also:
- Constant Field Values
-
PRESERVE_PARENT
public static final byte PRESERVE_PARENT
- See Also:
- Constant Field Values
-
SIMPLE_CONTENT
public static final byte SIMPLE_CONTENT
- See Also:
- Constant Field Values
-
ASSERTIONS_EXIST
public static final byte ASSERTIONS_EXIST
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Stripper
public Stripper(SpaceStrippingRule rule, Receiver next)
-
-
Method Detail
-
getAnother
public Stripper getAnother(Receiver next)
Get a clean copy of this stripper. The new copy shares the same PipelineConfiguration as the original, but the underlying receiver (that is, the destination for post-stripping events) is changed.- Parameters:
next- the next receiver in the pipeline for the new Stripper- Returns:
- a dublicate of this Stripper, with the output sent to "next".
-
open
public void open() throws XPathExceptionCallback interface for SAX: not for application use- Specified by:
openin interfaceReceiver- Overrides:
openin classProxyReceiver- Throws:
XPathException- if an error occurs
-
startElement
public void startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) throws XPathException
Description copied from class:ProxyReceiverNotify the start of an element- Specified by:
startElementin interfaceReceiver- Overrides:
startElementin classProxyReceiver- Parameters:
elemName- the name of the element.type- the type annotation of the element.attributes- the attributes of this elementnamespaces- the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elementslocation- an object providing information about the module, line, and column where the node originatedproperties- bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in classReceiverOption- Throws:
XPathException- if an error occurs
-
endElement
public void endElement() throws XPathExceptionHandle an end-of-element event- Specified by:
endElementin interfaceReceiver- Overrides:
endElementin classProxyReceiver- Throws:
XPathException- if an error occurs
-
characters
public void characters(java.lang.CharSequence chars, Location locationId, int properties) throws XPathExceptionHandle a text node- Specified by:
charactersin interfaceReceiver- Overrides:
charactersin classProxyReceiver- Parameters:
chars- The characterslocationId- provides information such as line number and system ID.properties- Bit significant value. The following bits are defined:- DISABLE_ESCAPING
- Disable escaping for this text node
- USE_CDATA
- Output as a CDATA section
- Throws:
XPathException- if an error occurs
-
usesTypeAnnotations
public boolean usesTypeAnnotations()
Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events- Specified by:
usesTypeAnnotationsin interfaceReceiver- Overrides:
usesTypeAnnotationsin classProxyReceiver- Returns:
- true if the Receiver makes any use of this information. If false, the caller may supply untyped nodes instead of supplying the type annotation
-
-