net.sf.saxon.event

Class WherePopulatedOutputter

java.lang.Object

net.sf.saxon.event.Outputter

net.sf.saxon.event.ProxyOutputter

net.sf.saxon.event.WherePopulatedOutputter

All Implemented Interfaces:

javax.xml.transform.Result, Receiver

public class WherePopulatedOutputter
extends ProxyOutputter

This class acts as a filter on a push pipeline, allowing through only those items that are deemed non-empty according to the rules of the xsl:where-populated instruction.

The items that are deemed empty, and therefore excluded, are:

• Document and element nodes having no children
• Nodes other than document and element nodes whose string value is zero-length
• Atomic values such that string(A) is zero-length
• Maps containing no entries
• Arrays which, when flattened, are either empty, or consist entirely of deemed-empty items

Note that these rules apply only to top-level items in the sequence passed through this Outputter. Events representing items nested within a top-level document or element node are always passed through; they are examined only to determine the emptiness or otherwise of their contained.

Field Summary

Fields inherited from class net.sf.saxon.event.Outputter

pipelineConfiguration, systemId

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

Constructors

Constructor and Description
WherePopulatedOutputter(Outputter next)

Method Summary

Modifier and Type	Method and Description
void	append(Item item) Append an arbitrary item (node, atomic value, or function) to the output.
void	append(Item item, Location locationId, int copyNamespaces) Append an arbitrary item (node, atomic value, or function) to the output.
void	attribute(NodeName attName, SimpleType typeCode, java.lang.CharSequence value, Location location, int properties) Notify an attribute.
void	characters(java.lang.CharSequence chars, Location locationId, int properties) Notify character data.
void	comment(java.lang.CharSequence content, Location location, int properties) Notify a comment.
void	endDocument() Notify the end of a document node
void	endElement() End of element
void	namespace(java.lang.String prefix, java.lang.String namespaceUri, int properties) Notify a namespace binding.
void	processingInstruction(java.lang.String name, java.lang.CharSequence data, Location location, int properties) Output a processing instruction
void	releaseStartTag()
void	startDocument(int properties) Start of a document node.
void	startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) Notify the start of an element
void	startElement(NodeName elemName, SchemaType type, Location location, int properties) Notify the start of an element

Methods inherited from class net.sf.saxon.event.ProxyOutputter

close, getNextOutputter, open, setUnparsedEntity, startContent, usesTypeAnnotations

Methods inherited from class net.sf.saxon.event.Outputter

getConfiguration, getPipelineConfiguration, getStringReceiver, getSystemId, namespaces, setPipelineConfiguration, setSystemId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.saxon.event.Receiver

handlesAppend

Constructor Detail

WherePopulatedOutputter

public WherePopulatedOutputter(Outputter next)

Method Detail

startDocument

public void startDocument(int properties)
                   throws XPathException

Start of a document node.

Specified by:

startDocument in interface Receiver

Overrides:

startDocument in class ProxyOutputter

Parameters:

properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOption

Throws:

XPathException - if an error occurs

startElement

public void startElement(NodeName elemName,
                         SchemaType type,
                         Location location,
                         int properties)
                  throws XPathException

Notify the start of an element

Overrides:

startElement in class ProxyOutputter

Parameters:

elemName - the name of the element.

type - the type annotation of the element.

location - an object providing information about the module, line, and column where the node originated

properties - bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in class ReceiverOption

Throws:

XPathException - if an error occurs

startElement

public void startElement(NodeName elemName,
                         SchemaType type,
                         AttributeMap attributes,
                         NamespaceMap namespaces,
                         Location location,
                         int properties)
                  throws XPathException

Notify the start of an element

Specified by:

startElement in interface Receiver

Overrides:

startElement in class ProxyOutputter

Parameters:

elemName - the name of the element.

type - the type annotation of the element.

attributes - the attributes of this element

namespaces - the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elements

location - an object providing information about the module, line, and column where the node originated

properties - bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in class ReceiverOption

Throws:

XPathException - if an error occurs

namespace

public void namespace(java.lang.String prefix,
                      java.lang.String namespaceUri,
                      int properties)
               throws XPathException

Notify a namespace binding.

Overrides:

namespace in class ProxyOutputter

Parameters:

prefix - The namespace prefix; zero-length string for the default namespace

namespaceUri - The namespace URI. In some cases a zero-length string may be used to indicate a namespace undeclaration.

properties - The REJECT_DUPLICATES property: if set, the namespace declaration will be rejected if it conflicts with a previous declaration of the same prefix. If the property is not set, the namespace declaration will be ignored if it conflicts with a previous declaration. This reflects the fact that when copying a tree, namespaces for child elements are emitted before the namespaces of their parent element. Unfortunately this conflicts with the XSLT rule for complex content construction, where the recovery action in the event of conflicts is to take the namespace that comes last. XSLT therefore doesn't recover from this error:

Throws:

XPathException - if an error occurs

attribute

public void attribute(NodeName attName,
                      SimpleType typeCode,
                      java.lang.CharSequence value,
                      Location location,
                      int properties)
               throws XPathException

Notify an attribute.

Overrides:

attribute in class ProxyOutputter

Parameters:

attName - The name of the attribute

typeCode - The type annotation of the attribute

value - the string value of the attribute

location - provides information such as line number and system ID.

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:

XPathException - if an error occurs

endDocument

public void endDocument()
                 throws XPathException

Notify the end of a document node

Specified by:

endDocument in interface Receiver

Overrides:

endDocument in class ProxyOutputter

Throws:

XPathException - if an error occurs

endElement

public void endElement()
                throws XPathException

End of element

Specified by:

endElement in interface Receiver

Overrides:

endElement in class ProxyOutputter

Throws:

XPathException - if an error occurs

releaseStartTag

public void releaseStartTag()
                     throws XPathException

Throws:

XPathException

characters

public void characters(java.lang.CharSequence chars,
                       Location locationId,
                       int properties)
                throws XPathException

Description copied from class: ProxyOutputter

Notify character data. Note that some receivers may require the character data to be sent in a single event, but in general this is not a requirement.

Specified by:

characters in interface Receiver

Overrides:

characters in class ProxyOutputter

Parameters:

chars - The characters

locationId - 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

processingInstruction

public void processingInstruction(java.lang.String name,
                                  java.lang.CharSequence data,
                                  Location location,
                                  int properties)
                           throws XPathException

Output a processing instruction

Specified by:

processingInstruction in interface Receiver

Overrides:

processingInstruction in class ProxyOutputter

Parameters:

name - The PI name. This must be a legal name (it will not be checked).

data - The data portion of the processing instruction

location - provides information such as line number and system ID.

properties - Additional information about the PI.

Throws:

java.lang.IllegalArgumentException - the content is invalid for an XML processing instruction

XPathException - if an error occurs

comment

public void comment(java.lang.CharSequence content,
                    Location location,
                    int properties)
             throws XPathException

Notify a comment. Comments are only notified if they are outside the DTD.

Specified by:

comment in interface Receiver

Overrides:

comment in class ProxyOutputter

Parameters:

content - The content of the comment

location - provides information such as line number and system ID.

properties - Additional information about the comment.

Throws:

java.lang.IllegalArgumentException - the content is invalid for an XML comment

XPathException - if an error occurs

append

public void append(Item item)
            throws XPathException

Description copied from class: ProxyOutputter

Append an arbitrary item (node, atomic value, or function) to the output. By default, if the item is an element node, it is copied with all namespaces. The default implementation calls ProxyOutputter.append(Item, Location, int), whose default implementation throws UnsupportedOperationException

Specified by:

append in interface Receiver

Overrides:

append in class ProxyOutputter

Parameters:

item - the item to be appended

Throws:

XPathException - if the operation fails

append

public void append(Item item,
                   Location locationId,
                   int copyNamespaces)
            throws XPathException

Description copied from class: ProxyOutputter

Append an arbitrary item (node, atomic value, or function) to the output. The default implementation throws UnsupportedOperationException.

Specified by:

append in interface Receiver

Overrides:

append in class ProxyOutputter

Parameters:

item - the item to be appended

locationId - the location of the calling instruction, for diagnostics

copyNamespaces - if the item is an element node, this indicates whether its namespaces need to be copied. Values are ReceiverOption.ALL_NAMESPACES; the default (0) means

Throws:

XPathException - if an error occurs