Package gnu.xml

Class NodeTree

java.lang.Object

gnu.lists.AbstractSequence<Object>

gnu.lists.TreeList

gnu.xml.NodeTree

All Implemented Interfaces:

Consumable, Consumer, PositionConsumer, XConsumer, Appendable, Consumer<Object>, DoubleConsumer, IntConsumer, LongConsumer

public class NodeTree
extends TreeList

Use to represent a Document or Document Fragment, in the XML DOM sense. More compact than traditional DOM, since it uses many fewer objects.

Field Summary

Fields inherited from class gnu.lists.TreeList

attrStart, BEGIN_ATTRIBUTE_LONG, BEGIN_ATTRIBUTE_LONG_SIZE, BEGIN_DOCUMENT, BEGIN_ELEMENT_LONG, BEGIN_ELEMENT_SHORT, BEGIN_ELEMENT_SHORT_INDEX_MAX, BEGIN_ENTITY, BEGIN_ENTITY_SIZE, data, docStart, DOCUMENT_URI, END_ATTRIBUTE_SIZE, END_DOCUMENT, END_ELEMENT_LONG, END_ELEMENT_SHORT, END_ENTITY, gapEnd, gapStart, INT_FOLLOWS, MAX_CHAR_SHORT, objects, oindex, POSITION_PAIR_FOLLOWS, PROCESSING_INSTRUCTION

Fields inherited from class gnu.lists.AbstractSequence

noInts

Constructor Summary

Constructors

Constructor	Description
NodeTree()

Method Summary

Modifier and Type	Method	Description
int	ancestorAttribute(int ipos, String namespace, String name)	Look for matching attribute in ancestor or self.
gnu.kawa.io.Path	baseUriOfPos(int pos, boolean resolveRelative)	Return of the base-uri property, if known, of the node at pos.
int	getAttribute(int parent, String namespaceURI, String localName)	Find named attribute.
int	getAttributeI(int parent, String namespaceURI, String localName)	Find named attribute.
int	getId()	Get/create a new unique number.
SeqPosition	getIteratorAtPos(int ipos)
int	lookupID(String name)	Look for an element with matching ID.
static NodeTree	make()
void	makeIDtableIfNeeded()
int	nextPos(int position)	Return the next position following the argument.
int	posFirstChild(int ipos)
boolean	posHasAttributes(int ipos)
boolean	posIsDefaultNamespace(int ipos, String namespaceURI)
String	posLocalName(int ipos)
String	posLookupNamespaceURI(int ipos, String prefix)
String	posLookupPrefix(int ipos, String namespaceURI)
String	posNamespaceURI(int ipos)
String	posPrefix(int ipos)
String	posTarget(int ipos)	Get the target of a process-instruction.
int	stableCompare(AbstractSequence other)	This is used for the XML concept of "document order".
String	toString()
Object	typedValue(int ipos)	Return the type-value of the node at the specified position.

Methods inherited from class gnu.lists.TreeList

append, append, append, beginEntity, clear, compare, consume, consumeIRange, consumeNext, consumePosRange, createPos, createRelativePos, documentUriOfPos, dump, dump, dump, endAttribute, endDocument, endElement, endEntity, ensureSpace, find, firstAttributePos, firstChildPos, get, getAttributeCount, getIndexDifference, getIntN, getLongN, getNextKind, getNextKindI, getNextTypeObject, getPosNext, getPosNextInt, getPosPrevious, gotoAttributesStart, gotoAttributesStart, gotoChildrenStart, hashCode, hasNext, ignoring, isEmpty, nextDataIndex, nextIndex, nextMatching, nextNodeIndex, parentOrEntityI, parentOrEntityPos, parentPos, posToDataIndex, reserveObjects, setAttributeName, setElementName, setIntN, size, startAttribute, startAttribute, startDocument, startElement, startElement, statistics, statistics, stringValue, stringValue, stringValue, toString, write, write, write, write, writeBoolean, writeByte, writeCDATA, writeComment, writeComment, writeDocumentUri, writeDouble, writeFloat, writeInt, writeIntForce32, writeJoiner, writeLong, writeObject, writePosition, writePosition, writeProcessingInstruction, writeProcessingInstruction

Methods inherited from class gnu.lists.AbstractSequence

add, add, addAll, addAll, addPos, asImmutable, badRank, boundedHash, checkCanWrite, checkRank, compare, compare, consume, contains, containsAll, copyPos, effectiveIndex, effectiveIndex, effectiveIndex, effectiveIndex, effectiveIndex, elements, endPos, equals, equals, fill, fill, fillPosRange, firstChildPos, fromEndIndex, get, get, get, get, getAttribute, getAttributeLength, getBooleanRaw, getByteRaw, getCharRaw, getContainingSequenceSize, getDoubleRaw, getElementKind, getFloatRaw, getInt, getInt, getInt, getInt, getInt, getIntRaw, getIterator, getIterator, getLongRaw, getLowBound, getNextTypeName, getRaw, getRowMajor, getShortRaw, getSize, getSize, gotoChildrenStart, gotoParent, hasPrevious, indexOf, isAfterPos, iterator, lastIndexOf, listIterator, listIterator, nextIndex, previousPos, rank, releasePos, remove, remove, removeAll, removePos, removePosRange, retainAll, set, set, setAt, setBuffer, setPosNext, setPosPrevious, setRaw, startPos, subList, subSequence, subSequencePos, toArray, toArray, unsupported, unsupportedException

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface gnu.lists.Consumer

accept, accept, accept, accept

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface java.util.function.DoubleConsumer

andThen

Methods inherited from interface java.util.function.IntConsumer

andThen

Methods inherited from interface java.util.function.LongConsumer

andThen

Constructor Detail

NodeTree

public NodeTree()

Method Detail

nextPos

public int nextPos(int position)

Description copied from class: AbstractSequence

Return the next position following the argument. The new position has the isAfter property. The argument is implicitly released (as in releasePos). Returns 0 if we are already at end of file.

Overrides:

nextPos in class TreeList

make

public static NodeTree make()

getId

public int getId()

Get/create a new unique number.

stableCompare

public int stableCompare(AbstractSequence other)

Description copied from class: AbstractSequence

This is used for the XML concept of "document order".

Overrides:

stableCompare in class AbstractSequence<Object>

getIteratorAtPos

public SeqPosition getIteratorAtPos(int ipos)

Overrides:

getIteratorAtPos in class AbstractSequence<Object>

posNamespaceURI

public String posNamespaceURI(int ipos)

posPrefix

public String posPrefix(int ipos)

posLocalName

public String posLocalName(int ipos)

posIsDefaultNamespace

public boolean posIsDefaultNamespace(int ipos,
                                     String namespaceURI)

posLookupNamespaceURI

public String posLookupNamespaceURI(int ipos,
                                    String prefix)

posLookupPrefix

public String posLookupPrefix(int ipos,
                              String namespaceURI)

posFirstChild

public int posFirstChild(int ipos)

posHasAttributes

public boolean posHasAttributes(int ipos)

getAttribute

public int getAttribute(int parent,
                        String namespaceURI,
                        String localName)

Find named attribute.

Parameters:

namespaceURI - need not be interned, or null which matches any namespace

localName - need not be interned, or null which matches any local name

Returns:

attribute ipos or 0

getAttributeI

public int getAttributeI(int parent,
                         String namespaceURI,
                         String localName)

Find named attribute.

Parameters:

namespaceURI - an interned String or null which matches any namespace

localName - an interned String, or null which matches any local name

Returns:

attribute ipos or 0

typedValue

public Object typedValue(int ipos)

Return the type-value of the node at the specified position.

posTarget

public String posTarget(int ipos)

Get the target of a process-instruction.

ancestorAttribute

public int ancestorAttribute(int ipos,
                             String namespace,
                             String name)

Look for matching attribute in ancestor or self.

Parameters:

namespace - namespaceURI (interned) of required attribute

name - localName(interned) of required attribute

Returns:

attribute ipos or 0

baseUriOfPos

public gnu.kawa.io.Path baseUriOfPos(int pos,
                                     boolean resolveRelative)

Return of the base-uri property, if known, of the node at pos.

toString

public String toString()

Overrides:

toString in class AbstractSequence<Object>

makeIDtableIfNeeded

public void makeIDtableIfNeeded()

lookupID

public int lookupID(String name)

Look for an element with matching ID. Returns an element ipos, or -1 if not found. Since we don't do any validation, for now only attributes with the name xml:id are recognized has having the is-id property. Assumes makeIDtableIfNeeded has been called at soem point.