rasmus_torkel.xml_basic.read.impl

Class TagNodeImpl

java.lang.Object

rasmus_torkel.xml_basic.read.SupportedNode

rasmus_torkel.xml_basic.read.TagNode

rasmus_torkel.xml_basic.read.impl.TagNodeImpl

public class TagNodeImpl
extends TagNode

Root node or element node in regular XML Jargon.

Field Summary

Fields inherited from class rasmus_torkel.xml_basic.read.TagNode

_id, _parent, _xmlContext

Fields inherited from class rasmus_torkel.xml_basic.read.SupportedNode

_textPos

Method Summary

Methods

Modifier and Type	Method and Description
TagNode	anyOrderChildN(java.lang.String relativeName, XmlNameSpace nameSpace)
XmlAttribute	attribute(int index)
int	attributeQty()
java.lang.String	attributeValueN(java.lang.String relativeName, XmlNameSpace nameSpace)
void	closeReader() This method closes the underlying reader.
ROTextPosition	endPosition() Return the text position of the end of the node.
boolean	isReaderOpen() Checks if reader is open.
TagNode	nextChildN()
TextNode	nextTextNodeN()
TagNode	peepChildN()
void	readRest() Reads the rest of the node.
void	setOrderedRetrieval() By setting this, the user guarantees that subnodes of this node will be retrieved in order.
java.lang.String	toString()
void	verifyNoMoreChildren() After reading all the child nodes that are expected, call this to verify that there are no additional child nodes.
void	verifyNoMoreText()
void	verifyNoOtherChildren(TagNodeId... expectedIds)

Methods inherited from class rasmus_torkel.xml_basic.read.TagNode

anyOrderBoolFieldD, anyOrderBoolFieldD, anyOrderBoolFieldD, anyOrderBoolFieldE, anyOrderBoolFieldE, anyOrderBoolFieldE, anyOrderBoolFieldN, anyOrderBoolFieldN, anyOrderBoolFieldN, anyOrderChildE, anyOrderChildE, anyOrderChildE, anyOrderChildN, anyOrderChildN, anyOrderConstFieldD, anyOrderConstFieldD, anyOrderConstFieldD, anyOrderConstFieldE, anyOrderConstFieldE, anyOrderConstFieldE, anyOrderConstFieldN, anyOrderConstFieldN, anyOrderConstFieldN, anyOrderDoubleFieldD, anyOrderDoubleFieldD, anyOrderDoubleFieldD, anyOrderDoubleFieldD, anyOrderDoubleFieldD, anyOrderDoubleFieldD, anyOrderDoubleFieldE, anyOrderDoubleFieldE, anyOrderDoubleFieldE, anyOrderDoubleFieldE, anyOrderDoubleFieldE, anyOrderDoubleFieldE, anyOrderDoubleFieldN, anyOrderDoubleFieldN, anyOrderDoubleFieldN, anyOrderDoubleFieldN, anyOrderDoubleFieldN, anyOrderDoubleFieldN, anyOrderEnumFieldD, anyOrderEnumFieldD, anyOrderEnumFieldD, anyOrderEnumFieldE, anyOrderEnumFieldE, anyOrderEnumFieldE, anyOrderEnumFieldN, anyOrderEnumFieldN, anyOrderEnumFieldN, anyOrderFloatFieldD, anyOrderFloatFieldD, anyOrderFloatFieldD, anyOrderFloatFieldD, anyOrderFloatFieldD, anyOrderFloatFieldD, anyOrderFloatFieldE, anyOrderFloatFieldE, anyOrderFloatFieldE, anyOrderFloatFieldE, anyOrderFloatFieldE, anyOrderFloatFieldE, anyOrderFloatFieldN, anyOrderFloatFieldN, anyOrderFloatFieldN, anyOrderFloatFieldN, anyOrderFloatFieldN, anyOrderFloatFieldN, anyOrderIntFieldD, anyOrderIntFieldD, anyOrderIntFieldD, anyOrderIntFieldD, anyOrderIntFieldD, anyOrderIntFieldD, anyOrderIntFieldE, anyOrderIntFieldE, anyOrderIntFieldE, anyOrderIntFieldE, anyOrderIntFieldE, anyOrderIntFieldE, anyOrderIntFieldN, anyOrderIntFieldN, anyOrderIntFieldN, anyOrderIntFieldN, anyOrderIntFieldN, anyOrderIntFieldN, anyOrderLongFieldD, anyOrderLongFieldD, anyOrderLongFieldD, anyOrderLongFieldD, anyOrderLongFieldD, anyOrderLongFieldD, anyOrderLongFieldE, anyOrderLongFieldE, anyOrderLongFieldE, anyOrderLongFieldE, anyOrderLongFieldE, anyOrderLongFieldE, anyOrderLongFieldN, anyOrderLongFieldN, anyOrderLongFieldN, anyOrderLongFieldN, anyOrderLongFieldN, anyOrderLongFieldN, anyOrderStringMappedFieldD, anyOrderStringMappedFieldD, anyOrderStringMappedFieldD, anyOrderStringMappedFieldE, anyOrderStringMappedFieldE, anyOrderStringMappedFieldE, anyOrderStringMappedFieldN, anyOrderStringMappedFieldN, anyOrderStringMappedFieldN, anyOrderTextFieldD, anyOrderTextFieldD, anyOrderTextFieldD, anyOrderTextFieldD, anyOrderTextFieldD, anyOrderTextFieldD, anyOrderTextFieldE, anyOrderTextFieldE, anyOrderTextFieldE, anyOrderTextFieldE, anyOrderTextFieldE, anyOrderTextFieldE, anyOrderTextFieldN, anyOrderTextFieldN, anyOrderTextFieldN, anyOrderTextFieldN, anyOrderTextFieldN, anyOrderTextFieldN, attributeBoolD, attributeBoolE, attributeBoolN, attributeConstD, attributeConstE, attributeConstN, attributeDoubleD, attributeDoubleD, attributeDoubleE, attributeDoubleE, attributeDoubleN, attributeDoubleN, attributeEnumD, attributeEnumE, attributeEnumN, attributeFloatD, attributeFloatD, attributeFloatE, attributeFloatE, attributeFloatN, attributeFloatN, attributeIntD, attributeIntD, attributeIntE, attributeIntE, attributeIntN, attributeIntN, attributeLongD, attributeLongD, attributeLongE, attributeLongE, attributeLongN, attributeLongN, attributes, attributeStringMappedD, attributeStringMappedE, attributeStringMappedN, attributeValueD, attributeValueD, attributeValueE, attributeValueE, attributeValueN, attributeValueN, checkConstAttribute, extractBoolFromAttrValue, extractDoubleFromAttrValue, extractDoubleFromAttrValue, extractEnumFromAttrValue, extractFloatFromAttrValue, extractFloatFromAttrValue, extractIntFromAttrValue, extractIntFromAttrValue, extractLongFromAttrValue, extractLongFromAttrValue, extractStringMappedFromAttrValue, idMatches, idMatches, makeAttributeDoesNotMatchTypeException, nextBoolFieldD, nextBoolFieldD, nextBoolFieldD, nextBoolFieldE, nextBoolFieldE, nextBoolFieldE, nextBoolFieldN, nextBoolFieldN, nextBoolFieldN, nextChildE, nextChildE, nextChildE, nextChildE, nextChildN, nextChildN, nextChildN, nextConstFieldD, nextConstFieldD, nextConstFieldD, nextConstFieldE, nextConstFieldE, nextConstFieldE, nextConstFieldN, nextConstFieldN, nextConstFieldN, nextDoubleFieldD, nextDoubleFieldD, nextDoubleFieldD, nextDoubleFieldD, nextDoubleFieldD, nextDoubleFieldD, nextDoubleFieldE, nextDoubleFieldE, nextDoubleFieldE, nextDoubleFieldE, nextDoubleFieldE, nextDoubleFieldE, nextDoubleFieldN, nextDoubleFieldN, nextDoubleFieldN, nextDoubleFieldN, nextDoubleFieldN, nextDoubleFieldN, nextEnumFieldD, nextEnumFieldD, nextEnumFieldD, nextEnumFieldE, nextEnumFieldE, nextEnumFieldE, nextEnumFieldN, nextEnumFieldN, nextEnumFieldN, nextFloatFieldD, nextFloatFieldD, nextFloatFieldD, nextFloatFieldD, nextFloatFieldD, nextFloatFieldD, nextFloatFieldE, nextFloatFieldE, nextFloatFieldE, nextFloatFieldE, nextFloatFieldE, nextFloatFieldE, nextFloatFieldN, nextFloatFieldN, nextFloatFieldN, nextFloatFieldN, nextFloatFieldN, nextFloatFieldN, nextIntFieldD, nextIntFieldD, nextIntFieldD, nextIntFieldD, nextIntFieldD, nextIntFieldD, nextIntFieldE, nextIntFieldE, nextIntFieldE, nextIntFieldE, nextIntFieldE, nextIntFieldE, nextIntFieldN, nextIntFieldN, nextIntFieldN, nextIntFieldN, nextIntFieldN, nextIntFieldN, nextLongFieldD, nextLongFieldD, nextLongFieldD, nextLongFieldD, nextLongFieldD, nextLongFieldD, nextLongFieldE, nextLongFieldE, nextLongFieldE, nextLongFieldE, nextLongFieldE, nextLongFieldE, nextLongFieldN, nextLongFieldN, nextLongFieldN, nextLongFieldN, nextLongFieldN, nextLongFieldN, nextStringArrayD, nextStringArrayD, nextStringArrayN, nextStringMappedFieldD, nextStringMappedFieldD, nextStringMappedFieldD, nextStringMappedFieldE, nextStringMappedFieldE, nextStringMappedFieldE, nextStringMappedFieldN, nextStringMappedFieldN, nextStringMappedFieldN, nextTextD, nextTextE, nextTextFieldD, nextTextFieldD, nextTextFieldD, nextTextFieldD, nextTextFieldD, nextTextFieldD, nextTextFieldE, nextTextFieldE, nextTextFieldE, nextTextFieldE, nextTextFieldE, nextTextFieldE, nextTextFieldN, nextTextFieldN, nextTextFieldN, nextTextFieldN, nextTextFieldN, nextTextFieldN, nextTextN, onlyBool, onlyDouble, onlyDouble, onlyEnum, onlyFloat, onlyFloat, onlyInt, onlyInt, onlyLong, onlyLong, onlyStringMapped, onlyText, onlyText, sortedAttributes, stringToEnum, verifyAttributeStringValue, verifyNoOtherChildren, verifyNoOtherChildren

Methods inherited from class java.lang.Object

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

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

closeReader

public void closeReader()

Description copied from class: TagNode

This method closes the underlying reader. If the reader calls another method that requires reading more XML on any node created using this reader, this will be an error condition. It's probably safest not too call any method on the nodes after closing the reader. However, closing multiple times is permitted.

Specified by:

closeReader in class TagNode

isReaderOpen

public boolean isReaderOpen()

Description copied from class: TagNode

Checks if reader is open.

Specified by:

isReaderOpen in class TagNode

Returns:

indication of whether underlying reader is open or not

setOrderedRetrieval

public void setOrderedRetrieval()

Description copied from class: TagNode

By setting this, the user guarantees that subnodes of this node will be retrieved in order. this means that subnode references can be dropped once we scan past the subnodes, allowing them to be picked up by garbage collection.

This option is only for this node. See read options if you want to specify this for the entire input.

Specified by:

setOrderedRetrieval in class TagNode

attributeQty

public int attributeQty()

Specified by:

attributeQty in class TagNode

attribute

public XmlAttribute attribute(int index)

Specified by:

attribute in class TagNode

attributeValueN

public java.lang.String attributeValueN(java.lang.String relativeName,
                               XmlNameSpace nameSpace)

Specified by:

attributeValueN in class TagNode

nextTextNodeN

public TextNode nextTextNodeN()

Specified by:

nextTextNodeN in class TagNode

Returns:

nextChildN

public TagNode nextChildN()

Specified by:

nextChildN in class TagNode

peepChildN

public TagNode peepChildN()

Specified by:

peepChildN in class TagNode

verifyNoMoreChildren

public void verifyNoMoreChildren()

Description copied from class: TagNode

After reading all the child nodes that are expected, call this to verify that there are no additional child nodes.

If this function succeeds on the root node, it will close the reader.

Specified by:

verifyNoMoreChildren in class TagNode

verifyNoMoreText

public void verifyNoMoreText()

Specified by:

verifyNoMoreText in class TagNode

endPosition

public ROTextPosition endPosition()

Description copied from class: TagNode

Return the text position of the end of the node. This must not be invoked unless one can be sure that the end of the node has actually been reached.

Specified by:

endPosition in class TagNode

Returns:

TextPosition of the end of the node

readRest

public void readRest()

Description copied from class: TagNode

Reads the rest of the node. If invoked on the root node, this method will close the reader.

Specified by:

readRest in class TagNode

anyOrderChildN

public TagNode anyOrderChildN(java.lang.String relativeName,
                     XmlNameSpace nameSpace)

Specified by:

anyOrderChildN in class TagNode

verifyNoOtherChildren

public void verifyNoOtherChildren(TagNodeId... expectedIds)

Specified by:

verifyNoOtherChildren in class TagNode