net.sf.saxon.style

Class UseWhenFilter

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.
Constructor Summary
UseWhenFilter(StartTagBuffer startTag)
Method Summary
voidattribute(int nameCode, int typeCode, CharSequence value, int locationId, int properties)
Notify an attribute.
voidcharacters(CharSequence chars, int locationId, int properties)
Character data
voidcomment(CharSequence chars, int locationId, int properties)
Output a comment
voidendElement()
End of element
booleanevaluateUseWhen(String expression, int locationId)
Evaluate a use-when attribute
voidnamespace(int namespaceCode, int properties)
Notify a namespace.
voidopen()
Start of document
voidprocessingInstruction(String target, CharSequence data, int locationId, int properties)
Processing Instruction
voidstartContent()
Notify the start of the content, that is, the completion of all attributes and namespaces.
voidstartElement(int nameCode, int typeCode, int locationId, int properties)
Notify the start of an element.

Constructor Detail

UseWhenFilter

public UseWhenFilter(StartTagBuffer startTag)

Method Detail

attribute

public void attribute(int nameCode, int typeCode, CharSequence value, int locationId, int properties)
Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.

Parameters: nameCode The name of the attribute, as held in the name pool typeCode The type of the attribute, as held in the name pool properties Bit significant value. The following bits are defined:

DISABLE_ESCAPING
Disable escaping for this attribute
NO_SPECIAL_CHARACTERS
Attribute value contains no special characters

Throws: IllegalStateException: attempt to output an attribute when there is no open element start tag

characters

public void characters(CharSequence chars, int locationId, int properties)
Character data

comment

public void comment(CharSequence chars, int locationId, int properties)
Output a comment

endElement

public void endElement()
End of element

evaluateUseWhen

public boolean evaluateUseWhen(String expression, int locationId)
Evaluate a use-when attribute

namespace

public void namespace(int namespaceCode, int properties)
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.

Parameters: namespaceCode an integer: the top half is a prefix code, the bottom half a URI code. These may be translated into an actual prefix and URI using the name pool. A prefix code of zero represents the empty prefix (that is, the default namespace). A URI code of zero represents a URI of "", that is, a namespace undeclaration.

Throws: IllegalStateException: attempt to output a namespace when there is no open element start tag

open

public void open()
Start of document

processingInstruction

public void processingInstruction(String target, CharSequence data, int locationId, int properties)
Processing Instruction

startContent

public void startContent()
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.

startElement

public void startElement(int nameCode, int typeCode, int locationId, int properties)
Notify the start of an element.

Parameters: nameCode integer code identifying the name of the element within the name pool. typeCode integer code identifying the element's type within the name pool. properties bit-significant properties of the element node