Package gnu.lists

Class TreeList

    • Field Detail

      • objects

        public Object[] objects
      • oindex

        public int oindex
      • data

        public char[] data
      • gapStart

        public int gapStart
      • gapEnd

        public int gapEnd
      • attrStart

        public int attrStart
        If non-zero, gap is in an attribute starting (1 less than) here.
      • docStart

        public int docStart
        If non-zero, gap is in an document starting (1 less than) here.
      • MAX_CHAR_SHORT

        public static final int MAX_CHAR_SHORT
        The largest Unicode character that can be encoded in one char.
        See Also:
        Constant Field Values
      • POSITION_PAIR_FOLLOWS

        protected static final char POSITION_PAIR_FOLLOWS
        A position triple referencing some other "nodes". Followed by index of sequence (2 chars), and ipos (2 chars).
        See Also:
        Constant Field Values
      • INT_FOLLOWS

        public static final int INT_FOLLOWS
        A 32-bit integer, non-compact form. [INT_FOLLOWS] [word1], [word2]: The big-endian bits of the integer.
        See Also:
        Constant Field Values
      • PROCESSING_INSTRUCTION

        protected static final int PROCESSING_INSTRUCTION
        A processing-instruction node follows. [PROCESSING_INSTRUCTION] [target] 2 shorts, where objects[target] is the target as a String. [length] 2 shorts. [comment text], (length) number of characters.
        See Also:
        Constant Field Values
      • BEGIN_ATTRIBUTE_LONG

        protected static final int BEGIN_ATTRIBUTE_LONG
        The beginning of an attribute. [BEGIN_ATTRIBUTE_LONG] [index], 2 shorts, where objects[index] is the attribute type name and objects[index+1] is the attribute type object. [end_offset], 2 shorts, giving the location of the following END_ATTRIBUTE. If the attribute straddles the gap, then end_offset is a negative offset relative to data.length. (Therefore allocating more space for the gap does not require adjusting end_offset.) Otherwise, the end_offset is relative to the BEGIN_ATTRIBUTE_LONG word.
        See Also:
        Constant Field Values
      • BEGIN_ATTRIBUTE_LONG_SIZE

        public static final int BEGIN_ATTRIBUTE_LONG_SIZE
        See Also:
        Constant Field Values
      • BEGIN_DOCUMENT

        protected static final int BEGIN_DOCUMENT
        Beginning of a document (or top-level value). Used to distinguish a document from its element node. [end_offset], 2 shorts, giving the location of the following END_DOCUMENT. If the attribute straddles the gap, then end_offset is a negative offset relative to data.length. (Therefore allocating more space for the gap does not require adjusting end_offset.) Otherwise, the end_offset is relative to the BEGIN_DOCUMENT word. [parent_offset], in 2 shorts. The parent node, or -1 if no parent. Otherwise, a negative value is a relative offset, while a non-negative value is absolute. (Use the latter when gap is between this node and its parent. The parent would normally be a BEGIN_ENTITY.
        See Also:
        Constant Field Values
      • END_DOCUMENT

        protected static final int END_DOCUMENT
        End of a document.
        See Also:
        Constant Field Values
      • BEGIN_ENTITY

        public static final int BEGIN_ENTITY
        Start of an entity (typically a file, possibly included). [base_uri], 2 shorts, given an index of a base-uri object [parent_offset], in 2 shorts, encoded as for BEGIN_DOCUMENT.
        See Also:
        Constant Field Values
      • DOCUMENT_URI

        protected static final int DOCUMENT_URI
        The document-uri property of a node. This is not an actual value, but it is a property of the previous document node, or the surrounding node just after a BEGIN_XXX entry. [DOCUMENT_URI] [index]. 2 shorts, where objects[index] is the document-uri value.
        See Also:
        Constant Field Values
      • BEGIN_ELEMENT_SHORT

        protected static final int BEGIN_ELEMENT_SHORT
        Beginning of an element, compact form. [BEGIN_ELEMENT_SHORT + index], where objects[index] is the element's type name and objects[index+1] is the type object. [end_offset], the unsigned offset (from the initial word) to the corresponding END_ELEMENT_SHORT. [parent_offset], the (unsigned absolute value of the) offset to the outer BEGIN_ELEMENT_SHORT/BEGIN_ELEMENT_LONG/BEGIN_DOCUMENT. . (If these is no parent, then parent_offset==0.) This should is used when index < BEGIN_ELEMENT_SHORT_INDEX_MAX, both end_offset and parent_offset fit in 16 bits, and the element does not straddle the gap.
        See Also:
        Constant Field Values
      • BEGIN_ELEMENT_SHORT_INDEX_MAX

        protected static final int BEGIN_ELEMENT_SHORT_INDEX_MAX
        See Also:
        Constant Field Values
      • END_ELEMENT_SHORT

        protected static final int END_ELEMENT_SHORT
        End of an element, compact form. [END_ELEMENT_SHORT] [begin_offset], the unsigned absolute value of the offset to the matching BEGIN. (This is the same as the matching end_offset.)
        See Also:
        Constant Field Values
      • BEGIN_ELEMENT_LONG

        protected static final int BEGIN_ELEMENT_LONG
        Begin of an element, non-compact form. [BEGIN_ELEMENT_LONG] [end_offset], in 2 shorts. The position of the matching END_ELEMENT_LONG. If the element straddles the gap, then end_offset is a negative offset relative to data.length. (Therefore allocating more space for the gap does not require adjusting any end_offset.) If the element and and its children are all on the same side of the gap, then end_offset is a positive offset relative to the BEGIN_ELEMENT_LONG word. (Hence shifting an entire element when the gap is moved does not require changing its end_offset.) Note that the space taken by a BEGIN_ELEMENT_LONG is the same that needed for a BEGIN_ELEMENT_SHORT (but a END_ELEMENT_LONG takes much more space than a END_ELEMENT_SHORT). This is to make it easier to convert a BEGIN_ELEMENT_LONG to a BEGIN_ELEMENT_SHORT or vice versa, as needed.
        See Also:
        Constant Field Values
      • END_ELEMENT_LONG

        protected static final int END_ELEMENT_LONG
        End of n element, non-compact form. [END_ELEMENT_LONG] [index], 2 shorts where objects[index] is the element's type name and objects[index+1] is the type object. [begin_offset], in 2 shorts. The position of the matching BEGIN_ELEMENT_LONG. If the element straddles the gap, then begin_offset is the actual index (i.e. relative to the start of data) of the matching BEGIN_ELEMENT_LONG. (Therefore allocating more space for the gap does not require adjusting begin_offset.) If the element does not straddle the gap, then begin_offset is a negative offset relative to the END_ELEMENT_LONG word. (Hence shifting an entire element when the gap is moved does not require changing its begin_offset.) relative to data.length. [parent_offset], in 2 shorts. The position of the outer BEGIN_ELEMENT_LONG, BEGIN_ELEMENT_SHORT or BEGIN_DOCUMENT. If the difference straddles the gap (i.e. either this element straddles the gap or the parent element does and the gap precedes this element), then parent_offset is the actual index of the parent element. Otherwise, then parent_offset is a negative offset relative to the END_ELEMENT_LONG word.
        See Also:
        Constant Field Values
    • Constructor Detail

      • TreeList

        public TreeList()
      • TreeList

        public TreeList​(TreeList list,
                        int startPosition,
                        int endPosition)
        Make a copy of a sub-range of a TreeList.
        Parameters:
        list - the TreeList to copy
        startPosition - start of range, as a raw index in data
        endPosition - end of range, as a raw index in data
      • TreeList

        public TreeList​(TreeList list)
    • Method Detail

      • ensureSpace

        public void ensureSpace​(int needed)
      • reserveObjects

        public final void reserveObjects​(int needed)
      • find

        public int find​(Object arg1)
      • getIntN

        protected final int getIntN​(int index)
        Get a 32-bit int from the data array.
      • getLongN

        protected final long getLongN​(int index)
        Get a 64-bit long from the data array.
      • setIntN

        public final void setIntN​(int index,
                                  int i)
      • writePosition

        public void writePosition​(SeqPosition position)
        Description copied from interface: PositionConsumer
        Consume node at current position. The caller may invalidate or change the position after consume returns, so if the consumer wants to save it, it needs to copy it.
        Specified by:
        writePosition in interface PositionConsumer
      • writePosition

        public void writePosition​(AbstractSequence seq,
                                  int ipos)
        Description copied from interface: PositionConsumer
        Consume a single position pair. This PositionConsumer may assume the sequence does no reference management; i.e. that copyPos is trivial and releasePos is a no-op. If that is not the case, use consume(TreePosition) instead.
        Specified by:
        writePosition in interface PositionConsumer
      • writeDocumentUri

        public void writeDocumentUri​(Object uri)
        Write/set the document-uri property of the current document. Only allowed immediately following startDocument.
      • writeComment

        public void writeComment​(char[] chars,
                                 int offset,
                                 int length)
        Specified by:
        writeComment in interface XConsumer
      • writeComment

        public void writeComment​(String comment,
                                 int offset,
                                 int length)
      • writeProcessingInstruction

        public void writeProcessingInstruction​(String target,
                                               String content,
                                               int offset,
                                               int length)
      • startElement

        public void startElement​(int index)
      • setElementName

        public void setElementName​(int elementIndex,
                                   int nameIndex)
      • startAttribute

        public void startAttribute​(Object attrType)
        Description copied from interface: Consumer
        Write a attribute for the current element. This is only allowed immediately after a startElement.
        Specified by:
        startAttribute in interface Consumer
      • startAttribute

        public void startAttribute​(int index)
      • setAttributeName

        public void setAttributeName​(int attrIndex,
                                     int nameIndex)
      • endAttribute

        public void endAttribute()
        Description copied from interface: Consumer
        End of an attribute or end of an actual parameter. The former use matches a startAttribute; the latter may not, and can be used to separate parameters in a parameter list. This double duty suggsts the method should at least be re-named.
        Specified by:
        endAttribute in interface Consumer
      • write

        public void write​(int c)
        Specified by:
        write in interface Consumer
      • writeBoolean

        public void writeBoolean​(boolean v)
        Specified by:
        writeBoolean in interface Consumer
      • writeByte

        public void writeByte​(int v)
      • writeInt

        public void writeInt​(int v)
        Specified by:
        writeInt in interface Consumer
      • writeIntForce32

        public void writeIntForce32​(int v)
      • writeLong

        public void writeLong​(long v)
        Specified by:
        writeLong in interface Consumer
      • writeFloat

        public void writeFloat​(float v)
        Specified by:
        writeFloat in interface Consumer
      • writeDouble

        public void writeDouble​(double v)
        Specified by:
        writeDouble in interface Consumer
      • ignoring

        public boolean ignoring()
        Description copied from interface: Consumer
        True if consumer is ignoring rest of element. The producer can use this information to skip ahead.
        Specified by:
        ignoring in interface Consumer
      • writeJoiner

        public void writeJoiner()
      • write

        public void write​(char[] buf,
                          int off,
                          int len)
        Specified by:
        write in interface Consumer
      • writeCDATA

        public void writeCDATA​(char[] chars,
                               int offset,
                               int length)
        Specified by:
        writeCDATA in interface XConsumer
      • createPos

        public int createPos​(int index,
                             boolean isAfter)
        Description copied from class: AbstractSequence
        Generate a position at a given index. The result is a position cookie that must be free'd with releasePos.
        Overrides:
        createPos in class AbstractSequence<Object>
        Parameters:
        index - offset from beginning of desired position
        isAfter - should the position have the isAfter property
      • posToDataIndex

        public final int posToDataIndex​(int ipos)
      • firstChildPos

        public int firstChildPos​(int ipos)
        Description copied from class: AbstractSequence
        Get position before first child (of the element following position).
        Overrides:
        firstChildPos in class AbstractSequence<Object>
        Parameters:
        ipos - parent position. It is not released by this method.
        Returns:
        non-zero position cookie if there is a child sequence (which might be empty); zero if current position is end of sequence or following element is atomic (cannot have children).
      • gotoChildrenStart

        public final int gotoChildrenStart​(int index)
      • parentPos

        public int parentPos​(int ipos)
        Description copied from class: AbstractSequence
        Get position of parent.
        Overrides:
        parentPos in class AbstractSequence<Object>
        Parameters:
        ipos - child position. It is not released by this method.
        Returns:
        the p os of the parent, or endPos() is there is no known parent.
      • parentOrEntityPos

        public int parentOrEntityPos​(int ipos)
      • parentOrEntityI

        public int parentOrEntityI​(int index)
      • getAttributeCount

        public int getAttributeCount​(int parent)
      • firstAttributePos

        public int firstAttributePos​(int ipos)
        Description copied from class: AbstractSequence
        Like firstChildPos. Problem: Should this stop before we get to children? I think so, but that requires changes to TreeList.
        Overrides:
        firstAttributePos in class AbstractSequence<Object>
      • gotoAttributesStart

        public int gotoAttributesStart​(int index)
      • consumeIRange

        public int consumeIRange​(int startPosition,
                                 int endPosition,
                                 Consumer out)
      • getNextKindI

        public int getNextKindI​(int index)
      • getPosPrevious

        public Object getPosPrevious​(int ipos)
        Description copied from class: AbstractSequence
        Get the element before the specified position.
        Overrides:
        getPosPrevious in class AbstractSequence<Object>
        Parameters:
        ipos - the specified position.
        Returns:
        the following element, or eofValue if there is none. FIXME Should change eof handling so return type can be E.
      • getPosNextInt

        public int getPosNextInt​(int ipos)
        Return following value (like getPosNext), as an integer.
      • getPosNext

        public Object getPosNext​(int ipos)
        Description copied from class: AbstractSequence
        Get the element following the specified position.
        Overrides:
        getPosNext in class AbstractSequence<Object>
        Parameters:
        ipos - the specified position.
        Returns:
        the following element, or eofValue if there is none. Called by SeqPosition.getNext. FIXME Should change eof handling so return type can be E.
      • stringValue

        public void stringValue​(int startIndex,
                                int endIndex,
                                StringBuffer sbuf)
      • stringValue

        public int stringValue​(int index,
                               StringBuffer sbuf)
      • stringValue

        public int stringValue​(boolean inElement,
                               int index,
                               StringBuffer sbuf)
      • nextNodeIndex

        public final int nextNodeIndex​(int pos,
                                       int limit)
        Skip all primitive content nodes.
      • nextMatching

        public int nextMatching​(int startPos,
                                ItemPredicate predicate,
                                int endPos,
                                boolean descend)
        Description copied from class: AbstractSequence
        Get next matching child or descendent (ignoring attributes).
        Overrides:
        nextMatching in class AbstractSequence<Object>
        Parameters:
        startPos - starting position
        predicate - a test (predicate) to apply to selected elements
        endPos - stop before endPos
        descend - if true do depth-first traversal.
        Returns:
        poistion of next match or 0 if none found
      • 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 AbstractSequence<Object>
      • nextDataIndex

        public final int nextDataIndex​(int pos)
      • documentUriOfPos

        public Object documentUriOfPos​(int pos)
      • compare

        public int compare​(int ipos1,
                           int ipos2)
        Compare two positions, and indicate their relative order.
        Overrides:
        compare in class AbstractSequence<Object>
      • statistics

        public void statistics()
      • statistics

        public void statistics​(PrintWriter out)
      • dump

        public void dump()
      • dump

        public void dump​(PrintWriter out,
                         int start,
                         int limit)