net.sf.saxon.expr.flwor.TuplePull Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of Saxon-HE Show documentation
Show all versions of Saxon-HE Show documentation
The XSLT and XQuery Processor
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2018-2022 Saxonica Limited
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
package net.sf.saxon.expr.flwor;
import net.sf.saxon.expr.XPathContext;
import net.sf.saxon.trans.XPathException;
/**
* Abtract class representing a tuple stream (used to evaluate a FLWOR expression) in pull mode
* (where the consumer of tuples activates the provider of those tuples)
*/
public abstract class TuplePull {
/**
* Move on to the next tuple. Before returning, this method must set all the variables corresponding
* to the "returned" tuple in the local stack frame associated with the context object
*
* @param context the dynamic evaluation context
* @return true if another tuple has been generated; false if the tuple stream is exhausted. If the
* method returns false, the values of the local variables corresponding to this tuple stream
* are undefined.
* @throws XPathException if any error occurs
*/
public abstract boolean nextTuple(XPathContext context) throws XPathException;
/**
* Close the tuple stream, indicating that although not all tuples have been read,
* no further tuples are required and resources can be released
*/
public void close() {
// default implementation takes no action
}
}