Package org.smooks.engine.delivery.dom.serialize

Class GhostElementSerializerVisitor

java.lang.Object

org.smooks.engine.delivery.dom.serialize.DefaultDOMSerializerVisitor

org.smooks.engine.delivery.dom.serialize.GhostElementSerializerVisitor

All Implemented Interfaces:

ContentHandler, AfterVisitor, BeforeVisitor, ChildrenVisitor, ElementVisitor, SaxNgVisitor, SerializerVisitor, Visitor, DOMSerializerVisitor

public class GhostElementSerializerVisitor
extends DefaultDOMSerializerVisitor
implements ElementVisitor

Ghost element serialization unit.

A ghost element can be used to "wrap" other DOM content. The Ghost element itself is not serialized, but it's child content is.

Author:

tom.fennelly@gmail.com

Field Summary

Fields inherited from class org.smooks.engine.delivery.dom.serialize.DefaultDOMSerializerVisitor

closeEmptyElements, domSerializer, rewriteEntities

Constructor Summary

Constructors

Constructor	Description
GhostElementSerializerVisitor()

Method Summary

Modifier and Type	Method	Description
static Element	createElement(Document ownerDocument)	Utility method for creating a <ghost-element/> element.
void	visitAfter(Element element, ExecutionContext executionContext)	Visits the end of an Element.
void	visitBefore(Element element, ExecutionContext executionContext)	Visits the beginning of an Element.
void	visitChildElement(Element childElement, ExecutionContext executionContext)	Visits a child Element.
void	visitChildText(CharacterData characterData, ExecutionContext executionContext)	Visits the character data of an Element.
void	writeEndElement(Element element, Writer writer, ExecutionContext executionContext)	Write the element end portion; close the element.
void	writeStartElement(Element element, Writer writer, ExecutionContext executionContext)	Write the element start portion; the element name and it's attributes.

Methods inherited from class org.smooks.engine.delivery.dom.serialize.DefaultDOMSerializerVisitor

postConstruct, setCloseEmptyElements, setRewriteEntities, writeCharacterData, writeChildElements, writeElementCDATA, writeElementComment, writeElementEntityRef, writeElementNode

Methods inherited from class java.lang.Object

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

Constructor Detail

GhostElementSerializerVisitor

public GhostElementSerializerVisitor()

Method Detail

writeStartElement

public void writeStartElement(Element element,
                              Writer writer,
                              ExecutionContext executionContext)
                       throws IOException

Description copied from interface: SerializerVisitor

Write the element start portion; the element name and it's attributes.

EG: <a href="http://www.x.com">

Specified by:

writeStartElement in interface SerializerVisitor

Overrides:

writeStartElement in class DefaultDOMSerializerVisitor

Parameters:

element - The element start to write.

writer - The writer to be written to.

executionContext - ExecutionContext instance for the delivery context.

Throws:

IOException - Exception writing output.

writeEndElement

public void writeEndElement(Element element,
                            Writer writer,
                            ExecutionContext executionContext)
                     throws IOException

Description copied from interface: SerializerVisitor

Write the element end portion; close the element.

EG: </a>

Specified by:

writeEndElement in interface SerializerVisitor

Overrides:

writeEndElement in class DefaultDOMSerializerVisitor

Parameters:

element - The element end to write.

writer - The writer to be written to.

executionContext - ExecutionContext instance for the delivery context.

Throws:

IOException - Exception writing output.

createElement

public static Element createElement(Document ownerDocument)

Utility method for creating a <ghost-element/> element.

Parameters:

ownerDocument - The owner document.

Returns:

The <ghost-element/> element.

visitAfter

public void visitAfter(Element element,
                       ExecutionContext executionContext)
                throws SmooksException

Description copied from interface: AfterVisitor

Visits the end of an Element.

Specified by:

visitAfter in interface AfterVisitor

Parameters:

element - the Element representing the end of the fragment. The Element's ancestors are traversable unless the global configuration parameter maintain.element.stack is set to false. The Element's child nodes are traversable if one of the following conditions are met:

• max.node.depth global config parameter is set to 0 or greater than 1, or
• this AfterVisitor implements ParameterizedVisitor.getMaxNodeDepth() which returns an integer greater than 1

executionContext - the current ExecutionContext

Throws:

SmooksException

visitBefore

public void visitBefore(Element element,
                        ExecutionContext executionContext)
                 throws SmooksException

Description copied from interface: BeforeVisitor

Visits the beginning of an Element.

Specified by:

visitBefore in interface BeforeVisitor

Parameters:

element - the Element representing the beginning of the fragment. The Element's ancestors are traversable unless the global configuration parameter maintain.element.stack is set to false. The Element's child nodes are not traversable.

executionContext - the current ExecutionContext

Throws:

SmooksException

visitChildText

public void visitChildText(CharacterData characterData,
                           ExecutionContext executionContext)

Description copied from interface: ChildrenVisitor

Visits the character data of an Element. This method is invoked once for each chunk of character data. A shortcut for collecting character data is to annotate the SaxNgVisitor implementation with org.smooks.engine.delivery.sax.annotation.StreamResultWriter, or stash the character data in a TextAccumulatorMemento and restore the TextAccumulatorMemento in AfterVisitor.visitAfter(Element, ExecutionContext).

Specified by:

visitChildText in interface ChildrenVisitor

Parameters:

characterData - the node which includes character data but not any child Elements. The Element's ancestors are traversable unless the global configuration parameter maintain.element.stack is set to false.

executionContext - the current ExecutionContext

visitChildElement

public void visitChildElement(Element childElement,
                              ExecutionContext executionContext)
                       throws SmooksException

Description copied from interface: ChildrenVisitor

Visits a child Element. This method is invoked once for each child Element.

Specified by:

visitChildElement in interface ChildrenVisitor

Parameters:

childElement - the child ElementElement's ancestors are traversable unless the global configuration parameter maintain.element.stack is set to false. The Element's child nodes are not traversable.

executionContext - the current ExecutionContext

Throws:

SmooksException