19f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson/* 29f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Licensed to the Apache Software Foundation (ASF) under one 39f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * or more contributor license agreements. See the NOTICE file 49f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * distributed with this work for additional information 59f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * regarding copyright ownership. The ASF licenses this file 69f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * to you under the Apache License, Version 2.0 (the "License"); 79f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * you may not use this file except in compliance with the License. 89f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * You may obtain a copy of the License at 99f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 109f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * http://www.apache.org/licenses/LICENSE-2.0 119f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 129f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Unless required by applicable law or agreed to in writing, software 139f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * distributed under the License is distributed on an "AS IS" BASIS, 149f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 159f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * See the License for the specific language governing permissions and 169f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * limitations under the License. 179f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 189f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson/* 199f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * $Id: ChildTestIterator.java 468655 2006-10-28 07:12:06Z minchau $ 209f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 219f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonpackage org.apache.xpath.axes; 229f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 239f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonimport org.apache.xml.dtm.Axis; 249f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonimport org.apache.xml.dtm.DTM; 259f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonimport org.apache.xml.dtm.DTMAxisTraverser; 269f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonimport org.apache.xml.dtm.DTMIterator; 279f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonimport org.apache.xpath.compiler.Compiler; 289f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 299f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson/** 309f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * This class implements an optimized iterator for 319f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * children patterns that have a node test, and possibly a predicate. 329f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @see org.apache.xpath.axes.BasicTestIterator 339f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @xsl.usage advanced 349f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 359f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonpublic class ChildTestIterator extends BasicTestIterator 369f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson{ 379f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson static final long serialVersionUID = -7936835957960705722L; 389f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** The traverser to use to navigate over the descendants. */ 399f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson transient protected DTMAxisTraverser m_traverser; 409f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 419f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** The extended type ID, not set until setRoot. */ 429f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// protected int m_extendedTypeID; 439f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 449f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 459f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 469f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Create a ChildTestIterator object. 479f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 489f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @param compiler A reference to the Compiler that contains the op map. 499f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @param opPos The position within the op map, which contains the 509f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * location path expression for this itterator. 519f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 529f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @throws javax.xml.transform.TransformerException 539f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 549f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson ChildTestIterator(Compiler compiler, int opPos, int analysis) 559f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson throws javax.xml.transform.TransformerException 569f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 579f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson super(compiler, opPos, analysis); 589f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 599f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 609f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 619f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Create a ChildTestIterator object. 629f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 639f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @param traverser Traverser that tells how the KeyIterator is to be handled. 649f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 659f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @throws javax.xml.transform.TransformerException 669f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 679f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public ChildTestIterator(DTMAxisTraverser traverser) 689f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 699f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 709f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson super(null); 719f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 729f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson m_traverser = traverser; 739f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 749f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 759f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 769f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Get the next node via getNextXXX. Bottlenecked for derived class override. 779f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @return The next node on the axis, or DTM.NULL. 789f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 799f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson protected int getNextNode() 809f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 819f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson if(true /* 0 == m_extendedTypeID */) 829f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 839f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson m_lastFetched = (DTM.NULL == m_lastFetched) 849f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson ? m_traverser.first(m_context) 859f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson : m_traverser.next(m_context, m_lastFetched); 869f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 879f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// else 889f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// { 899f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// m_lastFetched = (DTM.NULL == m_lastFetched) 909f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// ? m_traverser.first(m_context, m_extendedTypeID) 919f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// : m_traverser.next(m_context, m_lastFetched, 929f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// m_extendedTypeID); 939f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// } 949f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 959f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson return m_lastFetched; 969f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 979f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 989f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 999f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 1009f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Get a cloned Iterator that is reset to the beginning 1019f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * of the query. 1029f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 1039f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @return A cloned NodeIterator set of the start of the query. 1049f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 1059f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @throws CloneNotSupportedException 1069f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 1079f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public DTMIterator cloneWithReset() throws CloneNotSupportedException 1089f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 1099f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1109f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson ChildTestIterator clone = (ChildTestIterator) super.cloneWithReset(); 1119f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson clone.m_traverser = m_traverser; 1129f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1139f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson return clone; 1149f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 1159f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1169f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1179f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 1189f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Initialize the context values for this expression 1199f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * after it is cloned. 1209f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 1219f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @param context The XPath runtime context for this 1229f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * transformation. 1239f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 1249f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public void setRoot(int context, Object environment) 1259f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 1269f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson super.setRoot(context, environment); 1279f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson m_traverser = m_cdtm.getAxisTraverser(Axis.CHILD); 1289f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1299f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// String localName = getLocalName(); 1309f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// String namespace = getNamespace(); 1319f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// int what = m_whatToShow; 1329f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// // System.out.println("what: "); 1339f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// // NodeTest.debugWhatToShow(what); 1349f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// if(DTMFilter.SHOW_ALL == what || 1359f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// ((DTMFilter.SHOW_ELEMENT & what) == 0) 1369f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// || localName == NodeTest.WILD 1379f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// || namespace == NodeTest.WILD) 1389f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// { 1399f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// m_extendedTypeID = 0; 1409f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// } 1419f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// else 1429f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// { 1439f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// int type = getNodeTypeTest(what); 1449f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// m_extendedTypeID = m_cdtm.getExpandedTypeID(namespace, localName, type); 1459f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson// } 1469f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1479f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 1489f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1499f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 1509f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Returns the axis being iterated, if it is known. 1519f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 1529f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @return Axis.CHILD, etc., or -1 if the axis is not known or is of multiple 1539f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * types. 1549f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 1559f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public int getAxis() 1569f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 1579f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson return org.apache.xml.dtm.Axis.CHILD; 1589f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 1599f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1609f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 1619f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Detaches the iterator from the set which it iterated over, releasing 1629f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * any computational resources and placing the iterator in the INVALID 1639f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * state. After<code>detach</code> has been invoked, calls to 1649f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * <code>nextNode</code> or<code>previousNode</code> will raise the 1659f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * exception INVALID_STATE_ERR. 1669f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 1679f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public void detach() 1689f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 1699f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson if(m_allowDetach) 1709f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 1719f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson m_traverser = null; 1729f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1739f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // Always call the superclass detach last! 1749f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson super.detach(); 1759f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 1769f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 1779f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1789f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson} 179