io.sirix.axis.AncestorAxis Maven / Gradle / Ivy
/**
* Copyright (c) 2011, University of Konstanz, Distributed Systems Group All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted
* provided that the following conditions are met: * Redistributions of source code must retain the
* above copyright notice, this list of conditions and the following disclaimer. * 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.
* * Neither the name of the University of Konstanz nor the names of its contributors may be used to
* endorse or promote products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS 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 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.
*/
package io.sirix.axis;
import org.checkerframework.checker.index.qual.NonNegative;
import io.sirix.api.NodeCursor;
import io.sirix.node.NodeKind;
import io.sirix.settings.Fixed;
/**
*
* Iterate over all descendants of kind ELEMENT or TEXT starting at a given node. Self is not
* included.
*
*/
public final class AncestorAxis extends AbstractAxis {
/**
* First touch of node.
*/
private boolean mFirst;
/**
* Constructor initializing internal state.
*
* @param nodeCursor exclusive node cursor to iterate with
*/
public AncestorAxis(final NodeCursor nodeCursor) {
super(nodeCursor);
}
/**
* Constructor initializing internal state.
*
* @param nodeCursor exclusive node cursor to iterate with
* @param includeSelf Is self included?
*/
public AncestorAxis(final NodeCursor nodeCursor, final IncludeSelf includeSelf) {
super(nodeCursor, includeSelf);
}
@Override
public void reset(final @NonNegative long nodeKey) {
super.reset(nodeKey);
mFirst = true;
}
@Override
protected long nextKey() {
final NodeCursor cursor = getCursor();
// Self
if (mFirst && includeSelf() == IncludeSelf.YES) {
mFirst = false;
return cursor.getNodeKey();
}
if (cursor.getKind() != NodeKind.XML_DOCUMENT && cursor.hasParent()
&& cursor.getParentKey() != Fixed.DOCUMENT_NODE_KEY.getStandardProperty()) {
return cursor.getParentKey();
}
return done();
}
}