Package org.smooks.engine.resource.visitor.dom

Class ContextObjectSerializerVisitor

java.lang.Object

org.smooks.engine.resource.visitor.dom.ContextObjectSerializerVisitor

All Implemented Interfaces:

org.smooks.api.delivery.ContentHandler, org.smooks.api.resource.visitor.sax.ng.AfterVisitor, org.smooks.api.resource.visitor.sax.ng.BeforeVisitor, org.smooks.api.resource.visitor.sax.ng.ChildrenVisitor, org.smooks.api.resource.visitor.sax.ng.ElementVisitor, org.smooks.api.resource.visitor.sax.ng.SaxNgVisitor, org.smooks.api.resource.visitor.SerializerVisitor, org.smooks.api.resource.visitor.Visitor, DOMSerializerVisitor

public class ContextObjectSerializerVisitor
extends Object
implements DOMSerializerVisitor, org.smooks.api.resource.visitor.sax.ng.ElementVisitor

ExecutionContext object serializer.

Outputs an object bound to the ExecutionContext. The location of the object (context key) must be specified on the "key" attribute.

Author:

tom.fennelly@gmail.com

Constructor Summary

Constructors

Constructor	Description
ContextObjectSerializerVisitor()

Method Summary

Modifier and Type	Method	Description
static Element	createElement(Document ownerDocument, String key)	Utility method for creating a <context-object/> element.
static String	getContextKey(Element element)
static boolean	isContextObjectElement(Element element)
void	visitAfter(Element element, org.smooks.api.ExecutionContext executionContext)
void	visitBefore(Element element, org.smooks.api.ExecutionContext executionContext)
void	visitChildElement(Element childElement, org.smooks.api.ExecutionContext executionContext)
void	visitChildText(CharacterData characterData, org.smooks.api.ExecutionContext executionContext)
void	writeCharacterData(Node node, Writer writer, org.smooks.api.ExecutionContext executionContext)
boolean	writeChildElements()
void	writeElementCDATA(CDATASection cdata, Writer writer, org.smooks.api.ExecutionContext executionContext)
void	writeElementComment(Comment comment, Writer writer, org.smooks.api.ExecutionContext executionContext)
void	writeElementEntityRef(EntityReference entityRef, Writer writer, org.smooks.api.ExecutionContext executionContext)
void	writeElementNode(Node node, Writer writer, org.smooks.api.ExecutionContext executionContext)
void	writeEndElement(Element element, Writer writer, org.smooks.api.ExecutionContext executionContext)
void	writeStartElement(Element element, Writer writer, org.smooks.api.ExecutionContext executionContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextObjectSerializerVisitor

public ContextObjectSerializerVisitor()

Method Detail

writeStartElement

public void writeStartElement(Element element,
                              Writer writer,
                              org.smooks.api.ExecutionContext executionContext)
                       throws IOException

Specified by:

writeStartElement in interface org.smooks.api.resource.visitor.SerializerVisitor

Throws:

IOException

getContextKey

public static String getContextKey(Element element)

writeEndElement

public void writeEndElement(Element element,
                            Writer writer,
                            org.smooks.api.ExecutionContext executionContext)
                     throws IOException

Specified by:

writeEndElement in interface org.smooks.api.resource.visitor.SerializerVisitor

Throws:

IOException

writeCharacterData

public void writeCharacterData(Node node,
                               Writer writer,
                               org.smooks.api.ExecutionContext executionContext)
                        throws IOException

Specified by:

writeCharacterData in interface org.smooks.api.resource.visitor.SerializerVisitor

Throws:

IOException

writeElementComment

public void writeElementComment(Comment comment,
                                Writer writer,
                                org.smooks.api.ExecutionContext executionContext)
                         throws IOException

Specified by:

writeElementComment in interface org.smooks.api.resource.visitor.SerializerVisitor

Throws:

IOException

writeElementEntityRef

public void writeElementEntityRef(EntityReference entityRef,
                                  Writer writer,
                                  org.smooks.api.ExecutionContext executionContext)
                           throws IOException

Specified by:

writeElementEntityRef in interface org.smooks.api.resource.visitor.SerializerVisitor

Throws:

IOException

writeElementCDATA

public void writeElementCDATA(CDATASection cdata,
                              Writer writer,
                              org.smooks.api.ExecutionContext executionContext)
                       throws IOException

Specified by:

writeElementCDATA in interface org.smooks.api.resource.visitor.SerializerVisitor

Throws:

IOException

writeElementNode

public void writeElementNode(Node node,
                             Writer writer,
                             org.smooks.api.ExecutionContext executionContext)
                      throws IOException

Specified by:

writeElementNode in interface org.smooks.api.resource.visitor.SerializerVisitor

Throws:

IOException

writeChildElements

public boolean writeChildElements()

Specified by:

writeChildElements in interface org.smooks.api.resource.visitor.SerializerVisitor

createElement

public static Element createElement(Document ownerDocument,
                                    String key)

Utility method for creating a <context-object/> element.

Parameters:

ownerDocument - The owner document.

key - The context key.

Returns:

The <context-object/> element.

isContextObjectElement

public static boolean isContextObjectElement(Element element)

visitAfter

public void visitAfter(Element element,
                       org.smooks.api.ExecutionContext executionContext)
                throws org.smooks.api.SmooksException

Specified by:

visitAfter in interface org.smooks.api.resource.visitor.sax.ng.AfterVisitor

Throws:

org.smooks.api.SmooksException

visitBefore

public void visitBefore(Element element,
                        org.smooks.api.ExecutionContext executionContext)
                 throws org.smooks.api.SmooksException

Specified by:

visitBefore in interface org.smooks.api.resource.visitor.sax.ng.BeforeVisitor

Throws:

org.smooks.api.SmooksException

visitChildText

public void visitChildText(CharacterData characterData,
                           org.smooks.api.ExecutionContext executionContext)

Specified by:

visitChildText in interface org.smooks.api.resource.visitor.sax.ng.ChildrenVisitor

visitChildElement

public void visitChildElement(Element childElement,
                              org.smooks.api.ExecutionContext executionContext)
                       throws org.smooks.api.SmooksException

Specified by:

visitChildElement in interface org.smooks.api.resource.visitor.sax.ng.ChildrenVisitor

Throws:

org.smooks.api.SmooksException