All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.org.apache.xml.internal.dtm.ref.DTMAxisIterNodeList Maven / Gradle / Ivy

The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 *
 *
 * This file incorporates work covered by the following copyright and
 * permission notice:
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*
 * $Id: DTMAxisIterNodeList.java,v 1.8 2010-11-01 04:34:37 joehw Exp $
 */
package com.sun.org.apache.xml.internal.dtm.ref;

import com.sun.org.apache.xml.internal.dtm.DTM;
import com.sun.org.apache.xml.internal.dtm.DTMAxisIterator;
import com.sun.org.apache.xml.internal.utils.IntVector;

import org.w3c.dom.Node;

/**
 * DTMAxisNodeList gives us an implementation of the DOM's
 * NodeList interface wrapped around a DTM Iterator. The author
 * considers this something of an abominations, since NodeList was not
 * intended to be a general purpose "list of nodes" API and is
 * generally considered by the DOM WG to have be a mistake... but I'm
 * told that some of the XPath/XSLT folks say they must have this
 * solution.
 *
 * Please note that this is not necessarily equivlaent to a DOM
 * NodeList operating over the same document. In particular:
 * 
    * *
  • If there are several Text nodes in logical succession (ie, * across CDATASection and EntityReference boundaries), we will return * only the first; the caller is responsible for stepping through * them. * (%REVIEW% Provide a convenience routine here to assist, pending * proposed DOM Level 3 getAdjacentText() operation?)
  • * *
  • Since the whole XPath/XSLT architecture assumes that the source * document is not altered while we're working with it, we do not * promise to implement the DOM NodeList's "live view" response to * document mutation.
  • * *
* *

State: In progress!!

* */ public class DTMAxisIterNodeList extends DTMNodeListBase { private DTM m_dtm; private DTMAxisIterator m_iter; private IntVector m_cachedNodes; private int m_last = -1; //================================================================ // Methods unique to this class private DTMAxisIterNodeList() { } /** * Public constructor: Wrap a DTMNodeList around an existing * and preconfigured DTMAxisIterator */ public DTMAxisIterNodeList(DTM dtm, DTMAxisIterator dtmAxisIterator) { if (dtmAxisIterator == null) { m_last = 0; } else { m_cachedNodes = new IntVector(); m_dtm = dtm; } m_iter = dtmAxisIterator; } /** * Access the wrapped DTMIterator. I'm not sure whether anyone will * need this or not, but let's write it and think about it. * */ public DTMAxisIterator getDTMAxisIterator() { return m_iter; } //================================================================ // org.w3c.dom.NodeList API follows /** * Returns the indexth item in the collection. If * index is greater than or equal to the number of nodes in * the list, this returns null. * @param index Index into the collection. * @return The node at the indexth position in the * NodeList, or null if that is not a valid * index. */ public Node item(int index) { if (m_iter != null) { int node; int count = m_cachedNodes.size(); if (count > index) { node = m_cachedNodes.elementAt(index); return m_dtm.getNode(node); } else if (m_last == -1) { while (((node = m_iter.next()) != DTMAxisIterator.END) && count <= index) { m_cachedNodes.addElement(node); count++; } if (node == DTMAxisIterator.END) { m_last = count; } else { return m_dtm.getNode(node); } } } return null; } /** * The number of nodes in the list. The range of valid child node indices * is 0 to length-1 inclusive. */ public int getLength() { if (m_last == -1) { int node; while ((node = m_iter.next()) != DTMAxisIterator.END) { m_cachedNodes.addElement(node); } m_last = m_cachedNodes.size(); } return m_last; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy