Package Torello.HTML

Class CommentNodeIndex

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.CharSequence, java.lang.Cloneable, java.lang.Comparable<Replaceable>, Replaceable

    public class CommentNodeIndex
    extends NodeIndex<CommentNode>
    implements java.lang.CharSequence, java.io.Serializable, java.lang.Cloneable
    This is a simple data-class whose primary reason for development was to provide a way for the NodeSearch Package classes to simultaneously return both a CommentNode instance, and a Vector-index location (for that node) - at the same time - when searching HTML web-pages for HTML comments.

    CommentNodeIndex: CommentNode 'plus' the vector-index



    This class is just an extremely simple data-structure-class used, generally, for returning both the index of an instance-node of class 'CommentNode' inside a vectorized-html web-page, and also the CommentNode itself -simultaneously. The constructor of this class accepts an index, and a CommentNode, and saves both of these datum as public, final fields of this class. The 'Peek' suite of search methods in package NodeSearch return instances of this class.

    STALE DATA NOTE: If a vectorized-html webpage is modified after any of these Node + Index classes are created / instantiated, and nodes are added or removed from the webpage, then the (integer) index data inside these classes would have become stale when they are next accessed.

    The following public class definitions incorporate Vector-index and Vector-node-content into a single "combined unit" class:



    It is important to remember that Vector-position (a.k.a. "Vector-index") information that is stored inside Object instances of these (extremely-simple) classes will become stale, immediately if nodes are ever added or removed to the underlying Vector from which these Node + Index object-classes are created. This is because the 'index' is just a pointer into the Vector! For data-retrieval operations, these classes can prove highly useful. For page-modification operations, it is better to use the HTML Iterator / HNLI classes.
    See Also:
    CommentNode, NodeIndex, CommentNodePeek, Serialized Form


    • Field Detail

      • serialVersionUID

        🡇    
        public static final long serialVersionUID
        This fulfils the SerialVersion UID requirement for all classes that implement Java's interface java.io.Serializable. Using the Serializable Implementation offered by java is very easy, and can make saving program state when debugging a lot easier. It can also be used in place of more complicated systems like "hibernate" to store data as well.
        See Also:
        Constant Field Values
        Code:
        Exact Field Declaration Expression:
        public static final long serialVersionUID = 1;
        
    • Constructor Detail

      • CommentNodeIndex

        🡅  🡇    
        public CommentNodeIndex​(int index,
                                CommentNode commentNode)
        Constructor for this class.
        Parameters:
        index - This is the index of vectorized-page that contains commentNode
        commentNode - The CommentNode being stored in this data-structure.
        Throws:
        java.lang.IndexOutOfBoundsException - if index is negative, this exception is thrown.
        java.lang.NullPointerException - if commentNode is null.
        Code:
        Exact Constructor Body:
         super(index, commentNode);
        
    • Method Detail

      • clone

        🡅    
        public CommentNodeIndex clone()
        Java's interface Cloneable requirements. This instantiates a new CommentNodeIndex with identical CommentNode n and int index fields.
        Overrides:
        clone in class java.lang.Object
        Returns:
        A new CommentNodeIndex whose internal fields are identical to this one.
        Code:
        Exact Method Body:
         return new CommentNodeIndex(this.index, this.n);