| /* |
| * The Apache Software License, Version 1.1 |
| * |
| * |
| * Copyright (c) 1999-2003 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, |
| * if any, must include the following acknowledgment: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowledgment may appear in the software itself, |
| * if and wherever such third-party acknowledgments normally appear. |
| * |
| * 4. The names "Xalan" and "Apache Software Foundation" must |
| * not be used to endorse or promote products derived from this |
| * software without prior written permission. For written |
| * permission, please contact apache@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache", |
| * nor may "Apache" appear in their name, without prior written |
| * permission of the Apache Software Foundation. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation and was |
| * originally based on software copyright (c) 1999, Lotus |
| * Development Corporation., http://www.lotus.com. For more |
| * information on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| */ |
| package org.apache.xpath.axes; |
| |
| import java.util.Vector; |
| |
| import javax.xml.transform.TransformerException; |
| import org.apache.xml.dtm.Axis; |
| import org.apache.xml.dtm.DTM; |
| import org.apache.xml.utils.PrefixResolver; |
| import org.apache.xpath.Expression; |
| import org.apache.xpath.ExpressionOwner; |
| import org.apache.xpath.VariableStack; |
| import org.apache.xpath.XPathContext; |
| import org.apache.xpath.XPathVisitor; |
| import org.apache.xpath.objects.XNodeSet; |
| |
| /** |
| * Class to use for one-step iteration that doesn't have a predicate, and |
| * doesn't need to set the context. |
| */ |
| public class FilterExprIteratorSimple extends LocPathIterator |
| { |
| /** The contained expression. Should be non-null. |
| * @serial */ |
| private Expression m_expr; |
| |
| /** The result of executing m_expr. Needs to be deep cloned on clone op. */ |
| transient private XNodeSet m_exprObj; |
| |
| private boolean m_mustHardReset = false; |
| private boolean m_canDetachNodeset = true; |
| |
| /** |
| * Create a ChildTestIterator object. |
| * |
| * @param traverser Traverser that tells how the KeyIterator is to be handled. |
| * |
| * @throws javax.xml.transform.TransformerException |
| */ |
| public FilterExprIteratorSimple() |
| { |
| super(null); |
| } |
| |
| /** |
| * Create a ChildTestIterator object. |
| * |
| * @param traverser Traverser that tells how the KeyIterator is to be handled. |
| * |
| * @throws javax.xml.transform.TransformerException |
| */ |
| public FilterExprIteratorSimple(Expression expr) |
| { |
| super(null); |
| m_expr = expr; |
| } |
| |
| /** |
| * Initialize the context values for this expression |
| * after it is cloned. |
| * |
| * @param execContext The XPath runtime context for this |
| * transformation. |
| */ |
| public void setRoot(int context, Object environment) |
| { |
| super.setRoot(context, environment); |
| m_exprObj = executeFilterExpr(context, m_execContext, getPrefixResolver(), |
| getIsTopLevel(), m_stackFrame, m_expr); |
| } |
| |
| /** |
| * Execute the expression. Meant for reuse by other FilterExpr iterators |
| * that are not derived from this object. |
| */ |
| public static XNodeSet executeFilterExpr(int context, XPathContext xctxt, |
| PrefixResolver prefixResolver, |
| boolean isTopLevel, |
| int stackFrame, |
| Expression expr ) |
| throws org.apache.xml.utils.WrappedRuntimeException |
| { |
| PrefixResolver savedResolver = xctxt.getNamespaceContext(); |
| XNodeSet result = null; |
| |
| try |
| { |
| xctxt.pushCurrentNode(context); |
| xctxt.setNamespaceContext(prefixResolver); |
| |
| // The setRoot operation can take place with a reset operation, |
| // and so we may not be in the context of LocPathIterator#nextNode, |
| // so we have to set up the variable context, execute the expression, |
| // and then restore the variable context. |
| |
| if (isTopLevel) |
| { |
| // System.out.println("calling m_expr.execute(getXPathContext())"); |
| VariableStack vars = xctxt.getVarStack(); |
| |
| // These three statements need to be combined into one operation. |
| int savedStart = vars.getStackFrame(); |
| vars.setStackFrame(stackFrame); |
| |
| result = (org.apache.xpath.objects.XNodeSet) expr.execute(xctxt); |
| result.setShouldCacheNodes(true); |
| |
| // These two statements need to be combined into one operation. |
| vars.setStackFrame(savedStart); |
| } |
| else |
| result = (org.apache.xpath.objects.XNodeSet) expr.execute(xctxt); |
| |
| } |
| catch (javax.xml.transform.TransformerException se) |
| { |
| |
| // TODO: Fix... |
| throw new org.apache.xml.utils.WrappedRuntimeException(se); |
| } |
| finally |
| { |
| xctxt.popCurrentNode(); |
| xctxt.setNamespaceContext(savedResolver); |
| } |
| return result; |
| } |
| |
| /** |
| * Returns the next node in the set and advances the position of the |
| * iterator in the set. After a NodeIterator is created, the first call |
| * to nextNode() returns the first node in the set. |
| * |
| * @return The next <code>Node</code> in the set being iterated over, or |
| * <code>null</code> if there are no more members in that set. |
| */ |
| public int nextNode() |
| { |
| if(m_foundLast) |
| return DTM.NULL; |
| |
| int next; |
| |
| if (null != m_exprObj) |
| { |
| m_lastFetched = next = m_exprObj.nextNode(); |
| } |
| else |
| m_lastFetched = next = DTM.NULL; |
| |
| // m_lastFetched = next; |
| if (DTM.NULL != next) |
| { |
| m_pos++; |
| return next; |
| } |
| else |
| { |
| m_foundLast = true; |
| |
| return DTM.NULL; |
| } |
| } |
| |
| /** |
| * Detaches the walker from the set which it iterated over, releasing |
| * any computational resources and placing the iterator in the INVALID |
| * state. |
| */ |
| public void detach() |
| { |
| if(m_allowDetach) |
| { |
| super.detach(); |
| m_exprObj.detach(); |
| m_exprObj = null; |
| } |
| } |
| |
| /** |
| * This function is used to fixup variables from QNames to stack frame |
| * indexes at stylesheet build time. |
| * @param vars List of QNames that correspond to variables. This list |
| * should be searched backwards for the first qualified name that |
| * corresponds to the variable reference qname. The position of the |
| * QName in the vector from the start of the vector will be its position |
| * in the stack frame (but variables above the globalsTop value will need |
| * to be offset to the current stack frame). |
| */ |
| public void fixupVariables(java.util.Vector vars, int globalsSize) |
| { |
| super.fixupVariables(vars, globalsSize); |
| m_expr.fixupVariables(vars, globalsSize); |
| } |
| |
| /** |
| * Get the inner contained expression of this filter. |
| */ |
| public Expression getInnerExpression() |
| { |
| return m_expr; |
| } |
| |
| /** |
| * Set the inner contained expression of this filter. |
| */ |
| public void setInnerExpression(Expression expr) |
| { |
| expr.exprSetParent(this); |
| m_expr = expr; |
| } |
| |
| /** |
| * Get the analysis bits for this walker, as defined in the WalkerFactory. |
| * @return One of WalkerFactory#BIT_DESCENDANT, etc. |
| */ |
| public int getAnalysisBits() |
| { |
| if (null != m_expr && m_expr instanceof PathComponent) |
| { |
| return ((PathComponent) m_expr).getAnalysisBits(); |
| } |
| return WalkerFactory.BIT_FILTER; |
| } |
| |
| /** |
| * Returns true if all the nodes in the iteration well be returned in document |
| * order. |
| * Warning: This can only be called after setRoot has been called! |
| * |
| * @return true as a default. |
| */ |
| public boolean isDocOrdered() |
| { |
| return m_exprObj.isDocOrdered(); |
| } |
| |
| class filterExprOwner implements ExpressionOwner |
| { |
| /** |
| * @see ExpressionOwner#getExpression() |
| */ |
| public Expression getExpression() |
| { |
| return m_expr; |
| } |
| |
| /** |
| * @see ExpressionOwner#setExpression(Expression) |
| */ |
| public void setExpression(Expression exp) |
| { |
| exp.exprSetParent(FilterExprIteratorSimple.this); |
| m_expr = exp; |
| } |
| |
| } |
| |
| /** |
| * This will traverse the heararchy, calling the visitor for |
| * each member. If the called visitor method returns |
| * false, the subtree should not be called. |
| * |
| * @param owner The owner of the visitor, where that path may be |
| * rewritten if needed. |
| * @param visitor The visitor whose appropriate method will be called. |
| */ |
| public void callPredicateVisitors(XPathVisitor visitor) |
| { |
| m_expr.callVisitors(new filterExprOwner(), visitor); |
| |
| super.callPredicateVisitors(visitor); |
| } |
| |
| /** |
| * @see Expression#deepEquals(Expression) |
| */ |
| public boolean deepEquals(Expression expr) |
| { |
| if (!super.deepEquals(expr)) |
| return false; |
| |
| FilterExprIteratorSimple fet = (FilterExprIteratorSimple) expr; |
| if (!m_expr.deepEquals(fet.m_expr)) |
| return false; |
| |
| return true; |
| } |
| |
| /** |
| * Returns the axis being iterated, if it is known. |
| * |
| * @return Axis.CHILD, etc., or -1 if the axis is not known or is of multiple |
| * types. |
| */ |
| public int getAxis() |
| { |
| if(null != m_exprObj) |
| return m_exprObj.getAxis(); |
| else |
| return Axis.FILTEREDLIST; |
| } |
| |
| |
| } |
| |