org.primordion.xholon.io.htmlform

Class HtmlFormStrWriter

java.lang.Object

org.primordion.xholon.base.Xholon

org.primordion.xholon.io.xml.XmlWriter

org.primordion.xholon.io.htmlform.HtmlFormStrWriter

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable, IXholon, XholonMarker, IXmlWriter

public class HtmlFormStrWriter
extends XmlWriter

A concrete class that knows how to write an HTML Form through a Stax writer. There is no underlying 3rd-party HTML StAX writer, so this class will do the best it can on its own.

Since:

0.8.1 (Created on November 10, 2012)

See Also:

Xholon Project website, Serialized Form

Field Summary

Fields inherited from interface org.primordion.xholon.base.IXholon

DEFAULT_SIZE_MSG_Q, DEFAULT_SIZE_SYSTEM_MSG_Q, GETNAME_DEFAULT, GETNAME_LOCALPART_ID, GETNAME_NOROLENAME, GETNAME_ROLENAME_OR_CLASSNAME, GETNAME_ROLENAMESEP_, GETNAME_SIZE_TEMPLATE, NINCLUDE_PSC, NINCLUDE_PSx, NINCLUDE_PxC, NINCLUDE_Pxx, NINCLUDE_xSC, NINCLUDE_xSx, NINCLUDE_xxC, NINCLUDE_xxx, XHOLON_ID_DEFAULT, XHOLON_ID_NULL

Constructor Summary

Constructors

Constructor and Description
HtmlFormStrWriter() default constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	createNew(java.lang.Object out) Create a new instance of an XML writer, able to write to out.
void	flush() Write any cached data to the underlying output mechanism.
java.lang.String	getWriterName() Gets the name of the XmlWriter.
void	writeAttribute(java.lang.String name, java.lang.String value) Writes an attribute to the output stream.
void	writeComment(java.lang.String data) Writes an xml comment.
void	writeEndDocument() Closes any start tags and writes corresponding end tags.
void	writeEndElement(java.lang.String name) Writes an end tag to the output.
void	writeEndElement(java.lang.String name, java.lang.String namespaceURI) Writes an end tag to the output.
void	writeNamespace(java.lang.String prefix, java.lang.String namespaceURI) Writes a namespace to the output stream.
void	writeStartDocument() Write the XML Declaration.
void	writeStartElement(java.lang.String name) Writes a start tag to the output.
void	writeStartElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI) Writes a start tag to the output
void	writeText(java.lang.String text) Write text to the output.

Methods inherited from class org.primordion.xholon.io.xml.XmlWriter

isShouldWriteAllPorts, isShouldWriteVal, setShouldWriteAllPorts, setShouldWriteVal

Methods inherited from class org.primordion.xholon.base.Xholon

act, actNr, appendChild, appendChild, appendChild, appendsOwnChildren, bindPorts, cleanup, compareTo, configure, configure, consoleLog, decVal, decVal, depth, doAction, equals, findFirstChildWithXhClass, findFirstChildWithXhClass, forwardMessage, forwardSyncMessage, getActionList, getAllPorts, getAnnotation, getApp, getAttributeNodeXh, getAttributeXh, getChildNodes, getClassNode, getClassNode, getFactory, getFirstChild, getFirstSibling, getId, getInteraction, getInteractionsEnabled, getIQueueImplName, getLastChild, getLastSibling, getLogger, getMsgQ, getName, getName, getNeighbors, getNextSibling, getNthChild, getNthSibling, getNumChildren, getNumLevels, getNumSiblings, getParentNode, getPort, getPort, getPreviousSibling, getRoleName, getRootNode, getSelfAndSiblings, getSelfAndSiblingsIndex, getService, getSiblings, getSystemMsgQ, getUid, getUri, getVal_boolean, getVal_byte, getVal_char, getVal_double, getVal_float, getVal_int, getVal_long, getVal_Object, getVal_short, getVal_String, getVal, getXhc, getXhcId, getXhcName, getXholon2Xml, getXhType, getXml2Xholon, getXPath, handleNodeSelection, handleNodeSelection, hasAncestor, hasAnnotation, hasAttributeXh, hasChildNodes, hasChildOrSiblingNodes, hasNextSibling, hasParentNode, hasSiblingNodes, height, incVal, incVal, initialize, initStatics, inOrderPrint, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertFirstChild, isActiveObject, isAttributeHandler, isBound, isContainer, isExternal, isInternal, isLeaf, isPassiveObject, isRootNode, isUniqueSibling, isUniqueSiblingRoleName, performActivity, performActivity, performBooleanActivity, performBooleanActivity, performDoubleActivity, performGuard, performVoidActivity, postAct, postConfigure, postOrderPrint, postReconfigure, preAct, preConfigure, preOrderPrint, preReconfigure, print, println, processMessageQ, processReceivedMessage, processReceivedSyncMessage, processSystemMessageQ, reconfigure, registerMessageForwardee, remove, removeAttributeNodeXh, removeAttributeXh, removeChild, replaceNode, searchForReferencingNodes, searchForReferencingNodesRecurse, sendMessage, sendMessage, sendMessage, sendSyncMessage, sendSyncMessage, sendSyncMessage, sendSystemMessage, sendSystemMessage, setActionList, setAnnotation, setApp, setAttributeNodeXh, setAttributeVal, setAttributeXh, setFirstChild, setId, setName, setNextSibling, setParentChildLinks, setParentNode, setParentSiblingLinks, setPort, setPort, setPorts, setRoleName, setUid, setUri, setVal_boolean, setVal_byte, setVal_char, setVal_double, setVal_float, setVal_int, setVal_long, setVal_Object, setVal_short, setVal_String, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setXhc, showAnnotation, swapNode, terminate, toString, toXml, toXmlAttribute, toXmlAttributes, toXmlText, treeSize, visit

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HtmlFormStrWriter

public HtmlFormStrWriter()

default constructor

Method Detail

createNew

public void createNew(java.lang.Object out)

Description copied from interface: IXmlWriter

Create a new instance of an XML writer, able to write to out.

Specified by:

createNew in interface IXmlWriter

Specified by:

createNew in class XmlWriter

Parameters:

out - An output file, stream, string, or other type of writer. This must be an instance of java.io.Writer.

writeStartDocument

public void writeStartDocument()

Description copied from interface: IXmlWriter

Write the XML Declaration.

Specified by:

writeStartDocument in interface IXmlWriter

Specified by:

writeStartDocument in class XmlWriter

writeEndDocument

public void writeEndDocument()

Description copied from interface: IXmlWriter

Closes any start tags and writes corresponding end tags.

Specified by:

writeEndDocument in interface IXmlWriter

Specified by:

writeEndDocument in class XmlWriter

writeStartElement

public void writeStartElement(java.lang.String prefix,
                     java.lang.String localName,
                     java.lang.String namespaceURI)

Description copied from interface: IXmlWriter

Writes a start tag to the output

Specified by:

writeStartElement in interface IXmlWriter

Specified by:

writeStartElement in class XmlWriter

Parameters:

prefix - the prefix of the tag, may not be null

localName - local name of the tag, may not be null

namespaceURI - the uri to bind the prefix to, may not be null

writeStartElement

public void writeStartElement(java.lang.String name)

Description copied from interface: IXmlWriter

Writes a start tag to the output.

Specified by:

writeStartElement in interface IXmlWriter

Specified by:

writeStartElement in class XmlWriter

writeEndElement

public void writeEndElement(java.lang.String name,
                   java.lang.String namespaceURI)

Description copied from interface: IXmlWriter

Writes an end tag to the output. For use by XPP which requires a namespace if one was provided in the writeStartElement().

Specified by:

writeEndElement in interface IXmlWriter

Specified by:

writeEndElement in class XmlWriter

writeEndElement

public void writeEndElement(java.lang.String name)

Description copied from interface: IXmlWriter

Writes an end tag to the output.

Specified by:

writeEndElement in interface IXmlWriter

Specified by:

writeEndElement in class XmlWriter

writeNamespace

public void writeNamespace(java.lang.String prefix,
                  java.lang.String namespaceURI)

Description copied from interface: IXmlWriter

Writes a namespace to the output stream. For use by StAX.

Specified by:

writeNamespace in interface IXmlWriter

Specified by:

writeNamespace in class XmlWriter

Parameters:

prefix - the prefix to bind this namespace to

namespaceURI - the uri to bind the prefix to

writeAttribute

public void writeAttribute(java.lang.String name,
                  java.lang.String value)

Description copied from interface: IXmlWriter

Writes an attribute to the output stream.

Specified by:

writeAttribute in interface IXmlWriter

Specified by:

writeAttribute in class XmlWriter

writeText

public void writeText(java.lang.String text)

Description copied from interface: IXmlWriter

Write text to the output.

Specified by:

writeText in interface IXmlWriter

Specified by:

writeText in class XmlWriter

writeComment

public void writeComment(java.lang.String data)

Description copied from interface: IXmlWriter

Writes an xml comment.

Specified by:

writeComment in interface IXmlWriter

Specified by:

writeComment in class XmlWriter

getWriterName

public java.lang.String getWriterName()

Description copied from interface: IXmlWriter

Gets the name of the XmlWriter.

Specified by:

getWriterName in interface IXmlWriter

Specified by:

getWriterName in class XmlWriter

Returns:

A name, for example "XmlStaxWriter" or "XmlXppWriter".

flush

public void flush()

Description copied from interface: IXmlWriter

Write any cached data to the underlying output mechanism.

Specified by:

flush in interface IXmlWriter

Specified by:

flush in class XmlWriter