io.sirix.axis.DescendantAxis Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sirix-core Show documentation
Show all versions of sirix-core Show documentation
SirixDB is a hybrid on-disk and in-memory document oriented, versioned database system. It has a lightweight buffer manager, stores everything in a huge persistent and durable tree and allows efficient reconstruction of every revision. Furthermore, SirixDB implements change tracking, diffing and supports time travel queries.
/**
* 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 it.unimi.dsi.fastutil.longs.LongArrayList;
import org.checkerframework.checker.index.qual.NonNegative;
import io.sirix.api.NodeCursor;
/**
*
* Iterate over all structural descendants starting at a given node (in preorder). Self might or
* might not be included.
*
*/
public final class DescendantAxis extends AbstractAxis {
/** Stack for remembering next nodeKey in document order. */
private LongArrayList rightSiblingKeyStack;
/** Determines if it's the first call to hasNext(). */
private boolean first;
/**
* Constructor initializing internal state.
*
* @param cursor cursor to iterate with
*/
public DescendantAxis(final NodeCursor cursor) {
super(cursor);
}
/**
* Constructor initializing internal state.
*
* @param cursor cursor to iterate with
* @param includeSelf determines if current node is included or not
*/
public DescendantAxis(final NodeCursor cursor, final IncludeSelf includeSelf) {
super(cursor, includeSelf);
}
@Override
public void reset(final long nodeKey) {
super.reset(nodeKey);
first = true;
rightSiblingKeyStack = new LongArrayList();
}
@Override
protected long nextKey() {
long key;
final NodeCursor cursor = getCursor();
// Determines if first call to hasNext().
if (first) {
first = false;
if (includeSelf() == IncludeSelf.YES) {
key = cursor.getNodeKey();
} else {
key = cursor.getFirstChildKey();
}
return key;
}
// Always follow first child if there is one.
if (cursor.hasFirstChild()) {
key = cursor.getFirstChildKey();
if (cursor.hasRightSibling()) {
rightSiblingKeyStack.add(cursor.getRightSiblingKey());
}
return key;
}
// Then follow right sibling if there is one.
if (cursor.hasRightSibling()) {
final long currKey = cursor.getNodeKey();
key = cursor.getRightSiblingKey();
return hasNextNode(key, currKey);
}
// Then follow right sibling on stack.
if (rightSiblingKeyStack.size() > 0) {
final long currKey = cursor.getNodeKey();
key = rightSiblingKeyStack.popLong();
return hasNextNode(key, currKey);
}
return done();
}
/**
* Determines if the subtree-traversal is finished.
*
* @param key next key
* @param currKey current node key
* @return {@code false} if finished, {@code true} if not
*/
private long hasNextNode(@NonNegative final long key, final @NonNegative long currKey) {
final NodeCursor cursor = getCursor();
cursor.moveTo(key);
if (cursor.getLeftSiblingKey() == getStartKey()) {
return done();
} else {
cursor.moveTo(currKey);
return key;
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy