Package net.sf.saxon.style
Class UseWhenFilter
- java.lang.Object
-
- net.sf.saxon.event.SequenceReceiver
-
- net.sf.saxon.event.ProxyReceiver
-
- net.sf.saxon.style.UseWhenFilter
-
- All Implemented Interfaces:
javax.xml.transform.Result
,Receiver
public class UseWhenFilter extends ProxyReceiver
This is a filter inserted into the input pipeline for processing stylesheet modules, whose task is to evaluate use-when expressions and discard those parts of the stylesheet module for which the use-when attribute evaluates to false.
-
-
Field Summary
-
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 UseWhenFilter(Receiver next)
Create a UseWhenFilter
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
attribute(NodeName attName, SimpleType typeCode, java.lang.CharSequence value, int locationId, int properties)
Notify an attribute.void
characters(java.lang.CharSequence chars, int locationId, int properties)
Character datavoid
comment(java.lang.CharSequence chars, int locationId, int properties)
Output a commentvoid
endElement()
End of elementboolean
evaluateUseWhen(java.lang.String expression, int locationId)
Evaluate a use-when attributevoid
namespace(NamespaceBinding namespaceBinding, int properties)
Notify a namespace.void
open()
Start of documentvoid
processingInstruction(java.lang.String target, java.lang.CharSequence data, int locationId, int properties)
Processing Instructionvoid
setStartTagBuffer(StartTagBuffer startTag)
Set the start tag buffervoid
startContent()
Notify the start of the content, that is, the completion of all attributes and namespaces.void
startElement(NodeName elemName, SchemaType typeCode, int locationId, int properties)
Notify the start of an element.-
Methods inherited from class net.sf.saxon.event.ProxyReceiver
append, close, endDocument, getNamePool, getUnderlyingReceiver, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startDocument, usesTypeAnnotations
-
Methods inherited from class net.sf.saxon.event.SequenceReceiver
append, getConfiguration, getPipelineConfiguration, getSystemId
-
-
-
-
Constructor Detail
-
UseWhenFilter
public UseWhenFilter(Receiver next)
Create a UseWhenFilter- Parameters:
next
- the next receiver in the pipeline
-
-
Method Detail
-
setStartTagBuffer
public void setStartTagBuffer(StartTagBuffer startTag)
Set the start tag buffer- Parameters:
startTag
- a preceding filter on the pipeline that buffers the attributes of a start tag
-
open
public void open() throws XPathException
Start of document- Specified by:
open
in interfaceReceiver
- Overrides:
open
in classProxyReceiver
- Throws:
XPathException
- if an error occurs
-
startElement
public void startElement(NodeName elemName, SchemaType typeCode, int locationId, int properties) throws XPathException
Notify the start of an element.- Specified by:
startElement
in interfaceReceiver
- Overrides:
startElement
in classProxyReceiver
- Parameters:
elemName
- the name of the element.typeCode
- integer code identifying the element's type within the name pool.properties
- bit-significant properties of the element nodelocationId
- an integer which can be interpreted using aLocationProvider
to return information such as line number and system ID. If no location information is available, the value zero is supplied.- Throws:
XPathException
- if an error occurs
-
namespace
public void namespace(NamespaceBinding namespaceBinding, int properties) throws XPathException
Notify a namespace. Namespaces are notified after the startElement event, and before any children for the element. The namespaces that are reported are only required to include those that are different from the parent element; however, duplicates may be reported. A namespace must not conflict with any namespaces already used for element or attribute names.- Specified by:
namespace
in interfaceReceiver
- Overrides:
namespace
in classProxyReceiver
- Parameters:
namespaceBinding
-properties
- any special properties to be passed on this call- Throws:
XPathException
- if an error occurs
-
attribute
public void attribute(NodeName attName, SimpleType typeCode, java.lang.CharSequence value, int locationId, int properties) throws XPathException
Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.- Specified by:
attribute
in interfaceReceiver
- Overrides:
attribute
in classProxyReceiver
- Parameters:
attName
- The name of the attribute, as held in the name pooltypeCode
- The type of the attribute, as held in the name poolproperties
- Bit significant value. The following bits are defined:- DISABLE_ESCAPING
- Disable escaping for this attribute
- NO_SPECIAL_CHARACTERS
- Attribute value contains no special characters
value
- the string value of the attributelocationId
- an integer which can be interpreted using aLocationProvider
to return information such as line number and system ID. If no location information is available, the value zero is supplied.- Throws:
XPathException
- if an error occurs
-
startContent
public void startContent() throws XPathException
Notify the start of the content, that is, the completion of all attributes and namespaces. Note that the initial receiver of output from XSLT instructions will not receive this event, it has to detect it itself. Note that this event is reported for every element even if it has no attributes, no namespaces, and no content.- Specified by:
startContent
in interfaceReceiver
- Overrides:
startContent
in classProxyReceiver
- Throws:
XPathException
- if an error occurs
-
endElement
public void endElement() throws XPathException
End of element- Specified by:
endElement
in interfaceReceiver
- Overrides:
endElement
in classProxyReceiver
- Throws:
XPathException
- if an error occurs
-
characters
public void characters(java.lang.CharSequence chars, int locationId, int properties) throws XPathException
Character data- Specified by:
characters
in interfaceReceiver
- Overrides:
characters
in classProxyReceiver
- Parameters:
chars
- The characterslocationId
- an integer which can be interpreted using aLocationProvider
to return information such as line number and system ID. If no location information is available, the value zero is supplied.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
-
processingInstruction
public void processingInstruction(java.lang.String target, java.lang.CharSequence data, int locationId, int properties)
Processing Instruction- Specified by:
processingInstruction
in interfaceReceiver
- Overrides:
processingInstruction
in classProxyReceiver
- Parameters:
target
- The PI name. This must be a legal name (it will not be checked).data
- The data portion of the processing instructionlocationId
- an integer which can be interpreted using aLocationProvider
to return information such as line number and system ID. If no location information is available, the value zero is supplied.properties
- Additional information about the PI.
-
comment
public void comment(java.lang.CharSequence chars, int locationId, int properties) throws XPathException
Output a comment- Specified by:
comment
in interfaceReceiver
- Overrides:
comment
in classProxyReceiver
- Parameters:
chars
- The content of the commentlocationId
- an integer which can be interpreted using aLocationProvider
to return information such as line number and system ID. If no location information is available, the value zero is supplied.properties
- Additional information about the comment.- Throws:
XPathException
- if an error occurs
-
evaluateUseWhen
public boolean evaluateUseWhen(java.lang.String expression, int locationId) throws XPathException
Evaluate a use-when attribute- Parameters:
expression
- the expression to be evaluatedlocationId
- identifies the location of the expression in case error need to be reported- Returns:
- the effective boolean value of the result of evaluating the expression
- Throws:
XPathException
-
-