io.sirix.axis.PrecedingSiblingAxis 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 io.sirix.api.NodeCursor;
import io.sirix.node.NodeKind;
import io.sirix.settings.Fixed;
/**
*
* Iterate over all preceding siblings of kind ELEMENT or TEXT starting at a given node. Self is not
* included. Note that the axis conforms to the XPath specification and returns nodes in document
* order.
*
*
* @author Johannes Lichtenberger, University of Konstanz
*/
public final class PrecedingSiblingAxis extends AbstractAxis {
/** Determines if it's the first call. */
private boolean mIsFirst;
/**
* Constructor initializing internal state.
*
* @param cursor cursor to iterate with
*/
public PrecedingSiblingAxis(final NodeCursor cursor) {
super(cursor);
}
@Override
public void reset(final long nodeKey) {
super.reset(nodeKey);
mIsFirst = true;
}
@Override
protected long nextKey() {
final NodeCursor cursor = getCursor();
if (mIsFirst) {
mIsFirst = false;
final NodeKind kind = cursor.getKind();
if (kind == NodeKind.ATTRIBUTE || kind == NodeKind.NAMESPACE) {
// If the context node is an attribute or namespace node, the following-sibling axis is empty.
return done();
} else {
if (cursor.hasParent()) {
final long startNodeKey = cursor.getNodeKey();
cursor.moveToParent();
cursor.moveToFirstChild();
if (cursor.getNodeKey() == startNodeKey) {
return Fixed.NULL_NODE_KEY.getStandardProperty();
} else {
final long key = cursor.getNodeKey();
cursor.moveTo(startNodeKey);
return key;
}
}
}
}
if (cursor.hasRightSibling() && cursor.getRightSiblingKey() != getStartKey()) {
return cursor.getRightSiblingKey();
}
return done();
}
}