com.deltaxml.pipe.filters.dx2.wbw

Class WordBufferingFilter

java.lang.Object

org.xml.sax.helpers.XMLFilterImpl

com.deltaxml.pipe.XMLFilterImpl2

com.deltaxml.pipe.AncestorXMLFilter

com.deltaxml.pipe.filters.dx2.wbw.WordBufferingFilter

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler, org.xml.sax.ext.DeclHandler, org.xml.sax.ext.LexicalHandler, org.xml.sax.XMLFilter, org.xml.sax.XMLReader

Direct Known Subclasses:

OrphanedWordOutfilter, WordOutfilter, WordOutfilter62, WordRedGreenOutfilter, WordSpaceFixup62

public abstract class WordBufferingFilter
extends AncestorXMLFilter

This abstract filter should be extended by outfilters that process blocks of word/space/punctuation elements.

This SAX filter buffers adjacent word/punctuation/space elements to allow easier processing in word-by-word based filters. The default behaviour is to buffer all word/space/punctuation elements, however the filter can be constructed to buffer only word/space/punctuation elements inside a modified paragraph-level element.

The buffer is flushed in the following situations:

• reaching a start element which is not a word/space/punctuation element, and is not inside a word/space/punctuation element.
• reaching the end element for the paragraph-level element.

When the buffer is flushed, the WordBufferingFilter.flush() method is invoked. You should override WordBufferingFilter.processBuffer() to modify the buffer's contents prior to outputting and override WordBufferingFilter.outputBuffer() to output the buffer in a different format.

Constructor Summary

Constructors

Constructor and Description
WordBufferingFilter() Constructs a new WordBufferingFilter which will buffer all word/space/punctuation elements.
WordBufferingFilter(boolean bufferModifiedOnly) Constructs a new WordBufferingFilter specifying whether to construct a filter that will buffer all word/space/punctuation elements or one that filters just those that appear inside a modified paragraph-level element.

Method Summary

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length) Overrides the default characters method.
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName) Overrides the default endElement method.
boolean	isBufferModifiedOnly() Returns whether the filter is only buffering inside modified paragraph-level elements.
void	setwrapUnchangedText(java.lang.String value) Sets whether unchanged text should be wrapped in a deltaxml:textGroup.
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts) Overrides the default startElement method.
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri)

Methods inherited from class com.deltaxml.pipe.AncestorXMLFilter

endDocument, getClosestAttributeValueFromAncestor, getClosestAttributeValueFromAnyAncestor, getGrandParentLocalName, getParentLocalName, getParentQName, getProperty, hasAncestor, hasAncestor, hasAncestorWithAttr, hasAncestorWithAttrValue, hasAncestorWithAttrValues, outputCharacters, outputEndElement, outputStartElement, popAncestorStack, pushAncestorStack, setProperty, stackDepth, startDocument

Methods inherited from class com.deltaxml.pipe.XMLFilterImpl2

attributeDecl, comment, elementDecl, endCDATA, endDTD, endEntity, externalEntityDecl, internalEntityDecl, parse, parse, startCDATA, startDTD, startEntity

Methods inherited from class org.xml.sax.helpers.XMLFilterImpl

endPrefixMapping, error, fatalError, getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getFeature, getParent, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setContentHandler, setDocumentLocator, setDTDHandler, setEntityResolver, setErrorHandler, setFeature, setParent, skippedEntity, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

WordBufferingFilter

public WordBufferingFilter()

Constructs a new WordBufferingFilter which will buffer all word/space/punctuation elements.

WordBufferingFilter

public WordBufferingFilter(boolean bufferModifiedOnly)

Constructs a new WordBufferingFilter specifying whether to construct a filter that will buffer all word/space/punctuation elements or one that filters just those that appear inside a modified paragraph-level element.

Parameters:

bufferModifiedOnly - whether to only buffer word/punctuation/space elements inside modified paragraph-level elements.

Method Detail

setwrapUnchangedText

public void setwrapUnchangedText(java.lang.String value)

Sets whether unchanged text should be wrapped in a deltaxml:textGroup.

By default, unchanged text is not wrapped in a deltaxml:textGroup but if a value of true is passed to this method, unchanged text will be wrapped.

Parameters:

value - whether or not to wrap unchanged text in a deltaxml:textGroup

isBufferModifiedOnly

public boolean isBufferModifiedOnly()

Returns whether the filter is only buffering inside modified paragraph-level elements.

Returns:

whether the filter is only buffering inside modified paragraph-level elements

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)
                        throws org.xml.sax.SAXException

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

startPrefixMapping in class org.xml.sax.helpers.XMLFilterImpl

Throws:

org.xml.sax.SAXException

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes atts)
                  throws org.xml.sax.SAXException

Overrides the default startElement method.

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class AncestorXMLFilter

Parameters:

uri - the URI of the element's namespace

localName - the element's localname

qName - the element's qualified name

atts - the element's attributes

Throws:

org.xml.sax.SAXException - the superclass may throw an exception during processing.

See Also:

XMLFilterImpl.startElement(String, String, String, Attributes)

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

Overrides the default endElement method.

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class AncestorXMLFilter

Parameters:

uri - the URI of the element's namespace

localName - the element's localname

qName - the element's qualified name

Throws:

org.xml.sax.SAXException - the superclass may throw an exception during processing.

See Also:

XMLFilterImpl.endElement(String, String, String)

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

Overrides the default characters method.

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class org.xml.sax.helpers.XMLFilterImpl

Parameters:

ch - an array of characters

start - the starting position in the array

length - the number of characters to use from the array

Throws:

org.xml.sax.SAXException - the superclass may throw an exception during processing.

See Also:

XMLFilterImpl.characters(char[], int, int)